elm-review-documentation:提供榆木审核规则,以帮助改善榆木项目文档的质量和正确性

时间:2024-06-05 01:33:10
【文件属性】:

文件名称:elm-review-documentation:提供榆木审核规则,以帮助改善榆木项目文档的质量和正确性

文件大小:53KB

文件格式:ZIP

更新时间:2024-06-05 01:33:10

hacktoberfest elm-review JavaScript

榆木审查文件 提供规则,以帮助提高Elm项目文档的质量和正确性。 提供的规则 报告README.md中未指向程序包当前版本的链接。 配置 module ReviewConfig exposing ( config ) import Review.Rule exposing ( Rule ) import Documentation.ReadmeLinksPointToCurrentVersion config : List Rule config = [ Documentation . ReadmeLinksPointToCurrentVersion . rule ] 给软件包作者的建议 您可以通过运行elm make --docs=docs.json来要求编译器检查文档是否有效(例如,处于可发布状态)。 如果缺少文档,它将使编译失败,因此,如果项目尚未准备就绪,则可能无


【文件预览】:
elm-review-documentation-master
----.gitignore(62B)
----docs.json(1KB)
----package.json(706B)
----elm-review-package-tests()
--------helpers()
--------check-examples-were-updated.js(923B)
--------check-previews-compile.js(2KB)
----package-lock.json(107KB)
----src()
--------Documentation()
----LICENSE(1KB)
----elm.json(719B)
----.github()
--------ISSUE_TEMPLATE()
--------workflows()
----README.md(2KB)
----review()
--------src()
--------elm.json(1KB)
----tests()
--------Documentation()
----example()
--------src()
--------elm.json(1KB)
----preview()
--------src()
--------elm.json(994B)
----maintenance()
--------update-examples-from-preview.js(1KB)
--------MAINTENANCE.md(7KB)

网友评论