7 分钟内创建并发布 Node.js NPM 包
为什么要关注NPM?
为什么要关注NPM?
NPM,即 Node 包管理器,是臭名昭著的 JavaScript 运行时环境 Node.js 使用的默认包管理器。
与其直接下载软件包并将其放入 Node.js 源代码目录中,同时编写一堆繁琐的导入语句,不如直接:
-
运行此命令
npm install PACKAGE_NAME将软件包添加到/node_modules目录中。 -
添加
import VAR_NAME from 'PACKAGE_NAME';到您的来源。 -
使用已定义的变量名来使用包,例如
example()或example.includedFunction()。
绝大多数 JS 开发人员使用 NPM 或其速度更快的替代品 Yarn,只需几分钟即可安装他们的软件包。
如果你想开源一个 Node 库,你需要确保它已发布到 NPM 上。否则,它可能根本无法被任何人看到。
发布到 NPM
发布 NPM 项目
将软件包发布到 NPM 注册表的好处在于,它与从注册表安装软件包一样简单。
打开命令行界面 (CLI),输入几条命令,然后……你的代码就运行了。更详细的步骤请参见下文。
- 您需要确保要发布的目录是一个 NPM 项目。运行命令
npm init并完成自动提示即可。
- 确保库中的任何代码都能被 Node.js 用户正确导出。例如,我们将使用一个简单的测试命令进行
printMsg()导出:index.js
exports.printMsg = function() {
console.log('Here is our test message from our NPM package.')
}
- 打开生成的文件
package.json,并确保"main"密钥设置为您的库的入口文件。以下是一个示例index.js:
{
"name": "test-test-test-npm-package",
"version": "1.0.0",
"description": "A test npm package",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "Hays Stanford",
"license": "ISC"
}
- 完成上述所有设置后,就可以发布了!你只需要
npm publish在你的 NPM 项目目录中运行命令即可。
如果没有错误,那就大功告成了!你的 NPM 包已正式发布到公共 NPM 注册表中。就这么简单……
如果你想在 NPM 的公共注册表中看到你的 NPM 包,你可以通过在www.npmjs.com上搜索它来实现。
本教程中创建的软件包名为 test-test-test-npm-package,您可以点击此处查看。
希望这对你们有帮助!如果你们还想看其他内容,欢迎在推特上私信我。点击下方链接关注我的推特:
文章来源:https://dev.to/hays/create-publish-a-node-js-npm-package-in-7-minutes-4mek
自己动手开发并运行应用程序是学习编程的最佳途径。我就是这样学会开发 Ice Breakerr 的。更多信息请见:https://t.co/6VnKjK3nzR pic.twitter.com/6H5umiEmaq
— Hays Stanford (@haysstanford) 2018年11月23日


