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

Question

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

但是，看起来 docs 目录可能不会包含在打包的模块中，因此一旦安装，这些文档可能无法从标准产品中访问。

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

directories.doc

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

nicely, maybe, someday.

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

score 0 · Accepted Answer

在这里。最后，我和一个朋友一起在一个 ESLint fork 上添加了这个功能：https ://github.com/codeclimate/eslint/commit/fb68870708b1b3bbad80a955eec085a8dfd5f13b

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

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

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

complex_readup = docs.get("复杂度")

1 回答 1