在快速创建新软件包时,我仍然依靠一个不错的软件包模板存储库。我只是不想四处摆弄,而只是开始编码,运行绒毛/测试,构建和发布。因此,我创建了自己的自以为是的模板存储库。
TL; DR向我展示了存储库
jankapunkt / npm-package-template
ð使用Babel,Mocha,Chai,C8,StandardJS,JSDOC和汇总最小NPM包装模板。
📦 NPM Package Template - Zero Config 📦
最小测试和功能齐全的NPM软件包模板项目。
关于此软件包
此模板旨在允许您开始使用工作集开始立即开发 效果很好的工具和脚本。
几乎没有意见,只有最基本的工具才集成 如果您想要不同的风味,您可以分叉此项目,并轻松替换工具或添加新工具。
包括什么?
工具 /堆栈< / h3>
- ðª Babel for transpiling
-
Standard for linting
-
Mocha和Chai用于测试
-
c8用于代码覆盖
- ðJSDoc用于文档和jsdoc-to-markdown创建文档作为Markdown Files
-
-emoji> GitHub actions用于连续集成
- ð¦ Rollup for bundling
所有工具均定义为 dev-dependencies
!
文档和存储库
此模板存储库具有所有相关的GitHub社区标准:
工具 /堆栈
- ðBabel用于移动
- ðª Standard for linting
- â€Mocha和Chai用于测试
- ðc8用于代码覆盖范围
- ðJSDoc用于文档和jsdoc-to-markdown创建文档作为Markdown Files
- âGitHub actions用于连续集成
- ð¦ Rollup for bundling
所有工具均定义为 dev-dependencies
!
Github社区标准
模板存储库具有所有相关的GitHub社区标准。我只想更改详细信息,然后将其全部准备好发布:
- 描述
- readme
- 行为准则
- 贡献指南
- 许可证
- 安全策略
- 问题模板
- 拉请求模板
使用工具
存储库通过NPM脚本带有一组默认的工具集。从我的角度来看,这涵盖了创建/更新软件包时最必要的步骤。
命令 | 描述 | 输出 |
---|---|---|
lint |
在Read-Mode中运行Linter | |
lint:fix |
运行衬里;修复次要问题会自动 | |
test |
运行测试一次 | |
test:watch |
运行测试;在代码更改上重新运行它们 | |
test:coverage |
一次运行测试并创建覆盖范围报告 | coverage |
docs |
创建API文档 | docs |
build |
为多个目标平台构建捆绑包 | dist |
入门
如果您认为这是适合您的模板,那么只需create a new repository with this repository as template
或叉子存储库,然后将其克隆到您的本地机器。
jankapunkt / npm-package-template
ð使用Babel,Mocha,Chai,C8,StandardJS,JSDOC和汇总最小NPM包装模板。
📦 NPM Package Template - Zero Config 📦
最小测试和功能齐全的NPM软件包模板项目。
关于此软件包
此模板旨在允许您开始使用工作集开始立即开发 效果很好的工具和脚本。
几乎没有意见,只有最基本的工具才集成 如果您想要不同的风味,您可以分叉此项目,并轻松替换工具或添加新工具。
包括什么?
工具 /堆栈< / h3>
- ðª Babel for transpiling
-
Standard for linting
-
Mocha和Chai用于测试
-
c8用于代码覆盖
- ðJSDoc用于文档和jsdoc-to-markdown创建文档作为Markdown Files
-
-emoji> GitHub actions用于连续集成
- ð¦ Rollup for bundling
所有工具均定义为 dev-dependencies
!
文档和存储库
此模板存储库具有所有相关的GitHub社区标准:
关于我
我在此处定期在Dev.to上发表文章,大约 JavaScript ,特别是关于 Meteor JS 。
您还可以在GitHub,Twitter和LinkedIn上找到(并与我联系)。
如果您喜欢您正在阅读的内容并想支持我,则可以sponsor me on GitHub或send me a tip via PayPal。