什么应该放入npm包?

时间:2014-04-15 17:36:17

标签: node.js git npm

最近,我开始将我的应用程序node_modules文件夹提交到VCS,以加快部署并修复依赖关系。

我注意到很多npm软件包包含了一些对我来说不必要的东西,比如测试和我从未使用的各种构建,每当我把它放在我的回购中时,我都会皱纹。

那么,应该将什么放入npm包中?

1 个答案:

答案 0 :(得分:2)

测试和其他项目通常是包含在devDependencies中的好项目。

您可以使用npm install --production安装没有它们的软件包,或使用npm config set production

将配置标志设置为生产

我建议查看this page并阅读不同类型的依赖项中的信息,以了解每种依赖项的内容。

据说,包含的最低要求就是模块运行所需的最小值,但这取决于您正在创建的模块。虽然如果您公开分享您的软件包,README.md几乎是必不可少的,因此用户可以在npm和github上快速浏览您的软件包。