如何访问节点模块文档 - eslint

Question

我正在处理一个包装ESLint输出的项目，并希望访问每个警告的详细markdown文档的内容。这些文件位于docs/rules的ESLint存储库中。

但是，它看起来像打包模块中的docs目录might not get included，因此一旦安装，这些文档可能无法从标准产品中访问。

npm package.json文档也使得看起来文档可能通常不可用：

directories.doc

Put markdown files in here. Eventually, these will be displayed

nicely, maybe, someday.

我是处理节点包的新手，所以可能会遗漏一些明显的东西。谢谢你的任何想法！

Answer 1

OP在这里。最后，我和一位朋友在ESLint上合作，增加了这个功能：https://github.com/codeclimate/eslint/commit/fb68870708b1b3bbad80a955eec085a8dfd5f13b

如果有人想使用它，您可以使用我们的eslint分支并通过以下方式访问每个规则的文档：

var docs = require("eslint").docs;

其中docs是{rule_name：＆＃34; content string ....＆＃34;，...}

的对象

complexity_readup = docs.get（＆＃34;复杂性＆＃34;）