创建node.js模块
- Node.js 模块是一种可以发布到 npm 的包。当你创建一个新模块时,创建 package.json 文件是第一步。
- 你可以使用
npm init
命令创建 package.json 文件。命令行中将会提示 package.json 字段中需要你输入的值。名称(name) 和 版本(version) 这两个字段是必填的。你还需要输入 入口文件字段(main) 字段,当然,可以使用默认值 index.js。 - 创建 package.json 文件之后,还需要创建模块的入口文件。如果使用默认值,文件名是 index.js。
在此文件中,添加一个函数,作为 exports对象的一个属性。这样,require 此文件之后,这个函数在其他代码中就可以使用了。
eg:
exports.printMsg = function() {
console.log("This is a message from the demo package");
}
按照以下步骤试试:
- 将你的包发布到 npm。
- 在你的项目外新建一个目录。
- 然后 cd 进入这个新目录。
- 执行 npm install <package> 命令。
- 创建一个 test.js 文件,require 这个包,并调用其中的方法。
- 执行 node test.js 命令。是否输出 console.log 中填写的信息。
发布
你可以发布任何带有package.json目录的文件。下文解释了如何第一次发布包裹,以及如何在以后更新它。
准备
了解npm政策
在你开始之前,回顾一下npm的政策是一个好主意,以防你对网站礼仪、命名、许可或其他指导方针有疑问。
创建一个用户账号
要发布,您必须是npm注册中心的用户。如果您不是用户,则使用npm adduser创建一个帐户。如果您在站点上创建了一个用户帐户,请使用npm登录从您的终端访问您的帐户。
测试:
1.从终端输入npm who am i,看看您是否已经登录了(技术上,这也意味着您的凭证已经存储在本地)
2.在浏览器输入https://npmjs.com/~username
来验证你是否已经注册成功。
eg:我的:https://npmjs.com/~margery
检查package目录
1.检查内容
注意,目录中的所有内容都将被包括在内,除非它被本地的gitignore或.npmignore文件忽略。要学习如何使用这些命令,请参见npm开发。
检查你的package.json文件
确保你想要的内容都已经包含在package.json文件中。
选择一个名字
为您的包选择一个唯一的名称。试着选择一个描述性的名字。
- 不是别人拥有的
- 写不像另一个名字,除了拼写错误
- 不会混淆其他人的作者身份
- 满足npm政策指导方针。例如,不要把你的包裹命名为无礼的东西,不要使用别人的商标名。
- 在包的适当行中指定名称package.json文件。
包含一个说明性文档(readme.md)
npm建议您包含一个read.me文件来记录您的包。readme文件必须有文件名readme.md文件扩展。md表示文件是一个markdown文件。当有人发现你的包裹时,这个文件会出现在npm网站上。
在您开始之前,请查看一些软件包页面,以获得您可以添加到自述文件中的信息的想法,并了解为什么这是如此重要。
- 使用文本编辑器创建一个文件。
- 保存这个文件到项目的目录,命名为radme.md。
- 当你发布时,这个文件的内容将被显示到该项目的相应网页。
发布
使用 npm publish
来发布你的package
去浏览器中输入https://npmjs.com/package/<package>
你将看到一个包含所有packagede 信息。
如何更新你的package
如何更新你的版本号
当您进行更改时,您可以使用
npm version <update_type>
其中<update_type>一个semver类型,表示patch ,minor,或者major。
此命令将更改package.json中的版本号。
注意:如果你把一个标签连接到你的npm帐户,它还会在你的git仓库中添加一个标签。
更新版本号之后,运行npm publish
再次发布。
测试:https://npmjs.com/package/<package> 里面的包版本应该更新。
如何更新readme文件
除非您的包的新版本发布,否则站点上显示的README将不会被更新,因此您需要运行npm版本补丁和npm发布来更新站点上显示的文档。