NPM官方文档写的十分良心,此篇我做一些比较常用功能的积累,有些地方是翻译,有些地方省略可以去官文看。
NPM是什么?
npm是世界上最大的软件注册表,
npm由3个独立的部分组成:
- 网站:开发者查找包,设置参数以及管理npm使用体验的途径
- 注册表(registry):是一个巨大的数据库,保存了每个包的信息
- 命令行工具(CLI):终端,使用者通过cli操作npm
NPM可以做什么?
- 为你的项目引入packages
- 下载你可以立即使用的独立的工具
- 在任何地点和npm user 共享代码
- 设定代码开发权限
- 组件虚拟团队
- 管理代码版本和依赖
- 当底层代码更新时,轻松的更新应用程序
- 为难题找到多种解决途径
- 找到和你解决同一个问题的伙伴
安装npm 并管理npm版本
npm是用node.js编写的 ,首先要在电脑里安装node 环境,去node官网下载LTS(long time support )版本。
安装之后,run node -v
更新:
npm会在安装nodejs之后自动安装,通常npm的更新比node 更加频繁,确保你时刻是最新版本。
当前版本:npm -v
升级:npm install npm@latest -g
nvm
由于npm和node.js产品由不同的实体管理,因此更新和维护可能变得复杂。 此外,Node.js安装过程将npm安装在仅具有本地权限的目录中。 当您尝试全局运行包时,这可能会导致权限错误。为了解决这两个问题,许多开发人员选择使用版本管理器或nvm来安装npm。 版本管理器将避免权限错误,并将解决更新Node.js和npm的复杂性。
如何防止权限错误
当全局安装包时发生EACCES错误,看官方文档吧。
https://www.npmjs.com.cn/getting-started/fixing-npm-permissions/
如何安装本地包
- 本地安装 (模块依赖并通过require加载,命令的默认行为)
- 全局安装(将包作为一个命令行工具 比如gruntCLI)
选择哪种方式安装,取决于我如何使用这个包
npm install <packagename>
执行上面这句产出node_modules文件夹
使用 package.json
package.json文件:
- 列举了项目所有依赖
- 允许指定项目使用的包的版本
- 使构建过程可重现,更容易与其他开发同学共享
package.json命名规则:
“name”:小写字母,一个单词,不可以有空白字符,可以用破折号或下划线。
“version”:"1.2.3"
创建package.json文件:
npm init
或npm init --yes
区别是第一个会挨个字段询问答完一份调查问卷,--yes生成默认的文件
可以自定义一些字段比如:
npm set init.author.email "songleyigg@gmail.com"
npm set init.author.name "songleyi"
npm set init.license "MIT"
文档详述了如何定制调查问卷,我不太需要这块暂不赘述,知道可以定制就可以了。
如何更新本地安装的包
1.在 package.json文件所在目录执行npm update命令
2.再执行npm outdated不应该有任何输出
如何卸载本地安装的包
删除node_modules目录下的package
npm uninstall <package>
如需从package.json中删除依赖
npm uninstall --save <package>
注意:如果你将安装的包作为 "devDependency"(也就是通过 --save-dev 参数保存的),那么 --save 无法将其从 package.json 文件中删除。所以必须通过 --save-dev 参数可以将其卸载。
更新全局包
npm update -g <package>
检查哪些包过期
npm outdated -g --depth=0
更新所有全局包
npm update -g
卸载全局包
npm uninstall -g <package>
如何创建node.js模块(发包)
node.js模块是可以发布到npm的包,当你创建一个新模块时,创建package.json是第一步。
1.npm init 创建package.json文件(name ,version 必填)-->2.index.js(模块的入口文件)-->3.在index.js中添加一个函数,作为exports对象的一个属性--->4.require此文件之后,这个函数在其他代码中可用。
exports.printMsg = function(){
console.log("2018/11/6");
}
如何发布或者更新package(发包)
任何含有package.json的文件夹都可以被发布。
怎样发包
1.了解规则
开始之前,最好去看下npm政策,去了解网站的规则,命名规则,权限之类的限制。
2.创建一个用户账户
如果想发包,首先你必须是npm的注册用户。
假如不是,用npm adduser创建一个,是的话直接login。
terminal:
测试自己是否已经登录npm whoami
注册npm adduser
登录npm login
终端操作之后登录https://npmjs.com/~username就能看到你自己的账户。
3.确定package里面涵盖了你想要的所有信息。
包名:
名字不能重复,尽量描述性。
规定:
- 不能重名
- 拼写也不要像似,容易拼写错误。
- 你的名字不要让人误解不知道它的作者是谁。
- 符合npm政策指南。 例如,不要将您的包命名为冒犯性的,也不要使用其他人的商标名称。
- 在package.json文件的相应行中指定名称。
- 如果你使用scope,前三条不适用。
包含readme.md文档
npm建议你在文件夹里包含一个readme文件来记录解释你的package温建名规定叫readme.md,扩展名.md表明它是一个markdown文件,当有人搜索到你的package时,这个文档将会在npm网站上展现。
开始之前,看看人家的readme是怎么写的,理解他的重要性。
- 创建一个文件,用什么editor都行。
2.将它命名为readme.md,存在项目文件夹里。
3.发布之后,人们想要download你的package时会看到它。
发布啦!
npm publish
Use npm publish to publish the package.
去https://npmjs.com/package/<package>就能看到你发的包了啊。
怎么update
改版本号:
npm version <update_type>
其中<update_type>是语义版本控制版本之一,补丁,次要或主要版本。
这句命令会改变package.json里面的版本号。
如果关联了git,这也会将更新后的版本号添加到您的git存储库中。
更新之后,再次runnpm publish
去https://npmjs.com/package/<package>检查版本号应该已经被更新。
怎么更新readme
npm version patch
npm publish
如何使用语义化版本
在新版本的代码中说明更改的范围非常重要,因为有时更新会影响到package之间的依赖关系,语义版本控制(semver)是旨在解决此问题的标准。
Semver for publishers
如果你的项目要和别人分享,版本应该从1.0.0开始。
大小版本号更新按照如下的规矩:
如何使用scoped的包
需要npm版本在2以上
scope用来把相关联的包分组管理,为npm modules创建命名空间,比如一个domain。
名字以@开头的package是scoped package.范围是@和斜杠之间的所有内容。
例如:
@username/project-name
每个npm用户都有他自己的scope
想学习更多的scope相关知识,去这里https://docs.npmjs.com/misc/scope#publishing-public-scoped-packages-to-the-public-npm-registry
怎么初始化scoped package
{
"name":"@username/project-name"
}
如果使用npm init,可以使用命令行添加。
npm init --scope=username
如果您始终使用相同的范围,则可能需要在.npmrc文件中设置此选项。
npm config set scope username
发布scoped package
默认情况下,scoped package是私有的,想发私有module 的话,需要充值成为私有模块用户~~~~~emm
公共范围模块是免费的,不需要付费订阅。 要发布公共范围模块,请在发布时设置访问选项。 此选项将保留为所有后续发布设置。
npm publish --access=public
使用scoped package
要使用scoped package ,只要当使用包的时候在名称里加上范围。
package.json
{
"dependencies":{
"@username/project-name":"1.0.0"
}
}
终端输入:
npm install @username/project-name --save
引用时:
var projectName = require ("@username/project-name")
如何使用dist-tag标记包
分布标签(dist-tags)补充语义版本控制(例如,v0.12)。 使用它们来组织和标记不同版本的包。 除了比semver编号更具人性可读性之外,标签还允许发布者更有效地分发他们的包。
添加tag
将标记添加到包的特定版本:
npm dist-tag add <pkg>@<version> [<tag>]
使用标签发布:
默认情况下,npm发包会使用最近一次的tag。如果你使用--tag标记,你可以指定一个tag使用。例如:
npm publish --tag beta
使用标签install
同publish,npm install<pkg>默认使用最近一次的tag
。要重载此行为,使用:
npm install <pkg>@<tag>.
例如npm install somepkg@beta
注意事项
由于dist-tag与semver共享命名空间,为了避免冲突,最优的做法是避免使用数字或字母V作为tag的首字符。
Understanding Packages and Modules
Node.js和npm具有非常具体的包和模块定义,很容易混淆。 我们将在这里讨论这些定义,使它们区别开来,并解释为什么某些默认文件以它们的方式命名。
快速摘要
package:
package 是一个被package.json描述的文件或目录,它有很多种存在方式。
package可以是以下任何一种:
- (a)包含package.json文件描述的程序的文件夹。
- (b)包含a的压缩包
- (c)解析为b的地址
- (d)使用(c)在注册表上发布的<name> @ <version>。
- (e)指向(d)的<name> @ <tag>。
- (f)具有满足(e)的最新标签的<name>。
- (g)一个git url,当克隆时,会产生(a)。
注意到所有这些软件包的可能性,即使您从未将软件包发布到公共注册表,您仍然可以获得使用npm的许多好处:
module:
module是Node.js的require()可以加载的任何文件或目录。 同样,有几种配置允许这种情况发生。
module可以是以下任何一种:
- 包含主要字段的package.json文件的文件夹。
- 其中包含index.js文件的文件夹。
- 一个js文件。
大部分npm package 是 modules
通常,在node.js项目里面通过require来load packages,使他们成为modules,但是不要求npm packages是modules。
某些包(例如cli包)仅包含可执行的命令行界面,并且不提供在Node.js程序中使用的主要字段。 这些包不是模块。
几乎所有的包都包(packages)含很多的模块(modules)。
在Node程序的上下文中,模块也是从文件加载的东西。 例如,在以下程序中:
var req = require('request')
变量req就是引入的request模块。