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

【问题标题】：How to access node module documentation - eslint如何访问节点模块文档 - eslint
【发布时间】：2016-01-15 15:49:12
【问题描述】：

我正在开发一个包装 ESLint 输出的项目，并希望访问每个警告的详细降价文档的内容。这些文件位于 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.

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

【问题讨论】：

【解决方案1】：

在这里。最后，我和一位朋友一起开发了一个添加此功能的 ESLint 分支：https://github.com/codeclimate/eslint/commit/fb68870708b1b3bbad80a955eec085a8dfd5f13b

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

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

其中 docs 是一个具有 { rule_name: "content string....", ... }

的对象

complexity_readup = docs.get("complexity")

【讨论】：