node.js学习之npm 入门 —8.《怎样创建,发布,升级你的npm,node模块》

farmerz

怎样创建,发布,升级你的npm,node模块

原文

node.js module(模块)是package的一种,能够发布到npm。从创建一个package.json文件开始来创建一个module。

使用npm init来创建一个package.json文件,命令行会问你一些字段的值,除了name和version两个外,你需要设置一个main的值,也可使用默认的index.js作为值。详情看第五章

创建完package.json之后,你需要创建一个文件,该文件在你的模块require时能够引入,这个文件的默认名字是index.js

剩下的你可以在该文件中按照commond.js的模式来写入你的代码。

发布模块module

你可以发布你那个带有package.json的目录作为npm的package(module)。

准备

了解npm的政策

开始之前你最好去了解下npm的政策,应对你在网站礼仪,命名,授权等方面的问题。

发布一个npm package其实需要两个基本的东西:

一、 带有pckage.json,符合npm package规范的package。

二、在npm网站上注册了账户,并且在本地的npm中登录到了npm。具体如下:

1. 创建或登录一个用户帐号

发布之前,你必须是一个npm库的用户。如果你不是那么创建一个帐号,通过本地的命令行使用npm adduser按照提示来创建。如果你已经是该网站的用户那么只需使用npm login来登录下你的帐号即可。

验证:

  1. 在命令行输入npm whoami来检查你是否已经登录(同时你的凭证也会存储到本地)
  2. 在浏览器输入https://npmjs.com/~username来验证你是否已经注册成功。

例如我的:

https://www.npmjs.com/~cdd

2.检查package目录

  1. 检查内容

文件夹中除了在.gitignore或者.npmignore中定义的文件外,其他所有的文件都将包含到package中。更多信息

  1. 检查package.json文件

确保你想要的内容都已经包含在package.json文件中。设置详情

  • 选一个名字

为你的package起一个名字,限制如下:

  • 还没有被别人拥有
  • 不是拼写像另一个名字,除了错别字
  • 不会混淆他人的作者身份
  • 符合npm政策准则。例如,请勿将您的软件包命名为冒犯性的,并且不要使用他人的商标名称。
  • 在package.json文件的相应行中指定名称。

办一个说明文档(readme.md)

npm建议你在package中包含一个reade文件用来说明你的package。这个文件必须以readme.md命名。这个扩展名,表明这是一个markdown文件。当有人发现你的package时这个文件的内容将被显示到npm网站上(你的相应的package)。

开始之前最好参考一下别人是如何写这个文件的。

  1. 使用文本编辑器创建一个文件。
  2. 保存这个文件到项目的目录,命名为radme.md
  3. 当你发布时,这个文件的内容将被显示到该项目的相应网页。

发布

使用npm publish来发布你的package。

在浏览器输入https://npmjs.com/package/<package>你将看到你的这个新的package的信息。

怎样升级你的package

怎样升级版本号

当你对package做出修改后,你可以使用如下方法升级你的package:

npm version <update_type>

<update_type>是一个semver类型,表示patch ,minor,或者major。

这个命令将更改在项目中package.json中的version的值。

注意:如果你已经将一个标签与你的npm账户关联起来,那么这个标签还会添加一个带有更新版本号的标签到你的git仓库

更新版本号后,运行:

npm publish

该package在npm中的版本号也会更新。

怎样升级readme文件

显示在网站上的自述文件将不会更新,除非发布新版本的软件包,因此您需要运行npm version patch并npm publish更新网站上显示的文档。

阅读 803

前端这两年(2016~)
近几年来前端的变化记录

可可西里,可可西里,我只是想去看一看。

1.2k 声望
53 粉丝
0 条评论

可可西里,可可西里,我只是想去看一看。

1.2k 声望
53 粉丝
宣传栏