没有合适的资源?快使用搜索试试~ 我知道了~
checkdoc:CLI工具,提醒开发人员更新文档
共41个文件
js:21个
md:7个
json:5个
需积分: 5 0 下载量 36 浏览量
2021-04-12
05:10:40
上传
评论
收藏 97KB ZIP 举报
温馨提示
检查文件 即使文档是从代码中的注释生成的,也很容易忘记更新文档。 此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.zip (41个子文件)
checkdoc-master
package.json 1KB
.eslintrc.json 130B
.github
workflows
documentation.yml 496B
test.yml 469B
publish.yml 876B
cs.yml 482B
test
ConfigHelper.test.js 640B
.eslintrc.json 192B
FileChecker.test.js 2KB
FileListFactory.test.js 1000B
Error
Handler
ErrorSeverityErrorHandler.test.js 1KB
NoticeSeverityErrorHandler.test.js 806B
WarningSeverityErrorHandler.test.js 815B
ErrorHandlerFactory.test.js 1KB
UpdateRequiredError.test.js 687B
FileSource
GitDiffFileSource.test.js 1KB
ArgumentsFileSource.test.js 389B
LICENSE 34KB
package-lock.json 265KB
src
ConfigHelper.js 581B
FileListFactory.js 536B
Error
Handler
NoticeSeverityErrorHandler.js 261B
WarningSeverityErrorHandler.js 263B
ErrorSeverityErrorHandler.js 378B
ErrorHandlerFactory.js 562B
UpdateRequiredError.js 303B
FileSource
ArgumentsFileSource.js 94B
GitDiffFileSource.js 495B
FileChecker.js 1KB
.npmignore 28B
doc
Configuration.md 490B
CommandLine.md 972B
Configuration
from.md 1KB
documents.md 998B
severity.md 482B
reference.md 318B
.gitignore 113B
.checkdoc.json 1KB
README.md 2KB
.gitattributes 19B
cli.js 1KB
共 41 条
- 1
资源评论
徐校长
- 粉丝: 35
- 资源: 4615
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功