1. 创建npm账号
首先,去npm官方网站注册用户,创建完成后,会给你的注册邮箱发一个邮件进行校验,否则无法发布,会报如下错误:
npm ERR! code E403
npm ERR! 403 403 Forbidden - PUT http://registry.npmjs.org/postcss-pxtoremcalc - Forbidden
npm ERR! 403 In most cases, you or one of your dependencies are requesting
npm ERR! 403 a package version that is forbidden by your security policy.
2. 如果注册地址是淘宝镜像,则需要改npm注册地址
这一步不是必须的,假如注册地址是淘宝镜像,则需要先改回来。
查看命令:
npm get registry
修改命令:
npm config set registry http://registry.npmjs.org
操作完成后,如果需要,再改回来:
npm config set registry http://registry.npm.taobao.org/
3. 登录npm
登录命令:
npm addUser
输入用户名、密码、邮箱,如果输入错误,会报如下错误:
npm ERR! code E401
npm ERR! Incorrect or missing password.
npm ERR! If you were trying to login, change your password, create an
npm ERR! authentication token or enable two-factor authentication then
npm ERR! that means you likely typed your password in incorrectly.
npm ERR! Please try again, or recover your password at:
npm ERR! https://www.npmjs.com/forgot
npm ERR!
npm ERR! If you were doing some other operation then your saved credentials are
npm ERR! probably out of date. To correct this please try logging in again with:
npm ERR! npm login
4. 发布
发布命令,详情见官网:npm-publish | npm Docs (npmjs.com)
npm publish
有时我们不想整个项目都发布,有两种方式可以过滤:
第一种是“黑名单”法:
使用.npmignore
或.gitignore
,如果二者皆有(有时候是必要的,因为代码库和npm包很可能不一样,比如npm包只发布压缩包),则忽略.gitignore
,这意味着.gitignore
里配置的内容,需要在.npmignore
里重复配一次,当然,也可能npm包里有源码不存在的文件,根据实际需要配置就好。第二种是“白名单”法:
在package.json
里配置files
,示例:
"files": [
"dist/gw-login-template.umd.min.js"
]
无论那种方式,package.json
,README.md
,LICENSE
以及package.json
的main
里配置的文件这几个文件是一定会包含的,如果想看发布的结果,可以执行npx npm-packlist
命令查看:
npx npm-packlist
注意:2021.10.4日之后,npm必须使用TLS1.2以上版本才能发布,只要升级npm到7即可.升级方法:
npm i npm -g
npm update npm -g
npm -v
5. 去官网查看
https://www.npmjs.com/
如果查看具体包,则访问地址后加/package/包名
。
6. 下载使用
npm 会自动显示安装命令:npm i 包名
,但有时候我们需要安装到开发时依赖列表(devDependencies),这时候就需要在后边加--save-dev
,这些最好在readMe.md文件中说明。