文件名称：checkdoc:CLI工具，提醒开发人员更新文档
文件大小：97KB
文件格式：ZIP
更新时间：2024-05-01 22:57:20
cli automation documentation-tool npm-module JavaScript
检查文件 即使文档是从代码中的注释生成的，也很容易忘记更新文档。 此CLI工具可以通过确保无论何时更新文件，都提醒开发人员也更新相应的文档，从而为您提供帮助。 快速开始 使用npm安装软件包。 npm install @jaunty-script/checkdoc --save-dev 创建一个.checkdoc.json文件。 或者，在package.json文件中创建一个checkdoc部分。 { " documents " : [ { " file " : " README.md " , " dependents " : [ " index.js " ] } ] } 使用运行checkdoc npx 。 npx @jaunty-script/checkdoc 就是这样！ 这将使用git检查工作树和master分支之间的更改文件（
【文件预览】：
checkdoc-master
----package.json(1KB)
----.eslintrc.json(130B)
----.github()
--------workflows()
----test()
--------ConfigHelper.test.js(640B)
--------.eslintrc.json(192B)
--------FileChecker.test.js(2KB)
--------FileListFactory.test.js(1000B)
--------Error()
--------FileSource()
----LICENSE(34KB)
----package-lock.json(265KB)
----src()
--------ConfigHelper.js(581B)
--------FileListFactory.js(536B)
--------Error()
--------FileSource()
--------FileChecker.js(1KB)
----.npmignore(28B)
----doc()
--------Configuration.md(490B)
--------CommandLine.md(972B)
--------Configuration()
----.gitignore(113B)
----.checkdoc.json(1KB)
----README.md(2KB)
----.gitattributes(19B)
----cli.js(1KB)