github仓库同步到npm遇到的问题
使用NPM工具进行包管理
1.通过NPM提供的npm命令来进行依赖包的下载、升级和移除
2.通过package.json来定义软件包的元信息、开发依赖(开发或测试需要)、部署依赖(运行时需要)
3.依赖存储在node_modules中
4.依赖在项目之间是隔离的,全局安装(-g)会使它成为命令行工具而不是全局依赖
一、要实现的目标
github仓库同步到npm,然后开发人员直接引用npm包进行开发。
二、PR过程中遇到的问题
报错代码
error Couldn't publish package: "https://registry.yarnpkg.com/lr-vue-icon: You may not perform that action with these credentials."
info Visit https://yarnpkg.com/en/docs/cli/publish for documentation about this command.
Error: Process completed with exit code 1.
截图显示
三、登录自己的npm账号
方法一:适用于第一次使用npm发布,没有npm账号的情况
1.创建用户帐户
发布包之前你必须要注册一个npm的账号
2.初始化一个简单的项目并发布。(如果是克隆一个已有的项目到本地,这一步可以跳过)
a、本地创建一个文件夹:例如:z-tool
b、执行命令进入目录: $ cd z-tool
c、执行npm init 初始化项目。默认一路回车就行。
d、这样项目就初始化完成了,并生成了以packge.json文件。
默认字段简介:
name:发布的包名,默认是上级文件夹名。不得与现在npm中的包名重复。包名不能有大写字母/空格/下滑线!
version:你这个包的版本,默认是1.0.0。对于npm包的版本号有着一系列的规则,模块的版本号采用X.Y.Z的格式,具体体现为:
1、修复bug,小改动,增加z。
2、增加新特性,可向后兼容,增加y
3、有很大的改动,无法向下兼容,增加x
description:项目简介
mian:入口文件,默认是Index.js,可以修改成自己的文件
scripts:包含各种脚本执行命令
test:测试命令。
author:写自己的账号名
license:这个直接回车,开源文件协议吧,也可以是MIT,看需要吧。
e、在z-tool文件夹中创建一个文件名为index.js的文件,简单的写了一下内容。
!function(){
console.log(`这是引入的包入口`)
}()
四、本电脑第一次发布npm包,需要添加第一步创建的 Npm 账号,执行下面操作。
打开终端,或者Vscode,并按快捷键ctrl+`,打开终端
输入npm adduser,提示输入账号,密码和邮箱,界面不显示,直管输入,按回车即可,然后提示创建成功。
LiudeMac-Pro:lr-vue-icon liu$ npm adduser
Username: lrachel //这里填写npm账户名
Password: //这里填写npm密码,填写完不显示,按回车即可
Email: (this IS public) 19437712665@qq.com //这里填写npm邮箱
npm notice Please check your email for a one-time password (OTP)
Enter one-time password from your authenticator app: 89428650 //这里填写邮箱验证码
Logged in as lrachel on https://registry.npmjs.org/. //表示登录成功。
方法二、已有npm账号,在本电脑终端登录发布过npm包,
只需要在终端输入npm login,然后输入账号、密码、邮箱和邮箱验证码,同方法二。
四、发布npm包
发布上传包
npm publish
如果是发布到公开组织(public organization)
npm publish --access public
成功发布:
LiudeMac-Pro:lr-vue-icon liu$ npm publish
npm notice
npm notice lr-vue-icon@0.0.4
···
npm notice
+ lr-vue-icon@0.0.4
五、查询发布的npm包
到 npm官网 链接
全局搜索即可
六、引用和使用npm包
1.下载安装依赖包
2.调用npm包中的方法
3.更新npm包
a.修改内容
b.更新版本号
c.再次发布
d.更新使用依赖包
七、撤销发布的npm包
如果因为某种原因需要撤销已经发布提交的npm包
超过24小时后无法撤销
npm --force unpublish <your-package-name> // 删除整个npm市场的包
npm unpublish <lr-vue-icon@1.0.0> // 删除某个版本
注意
在24小时加上 --force强制执行才可以实现。即使撤销了发布的包,再次发布的时候也不能与之前被撤销的包的名称和版本其中之一相同,包名和包版本组成唯一标识,即使撤销也并不会消失,不能重复使用。
撤销的包不能立马再次发布,撤销24小时后才能再次发布。
不过撤包推荐用法: npm unpublish的推荐替代命令:npm deprecate [@] 使用这个命令,并不会在社区里撤销你已有的包,但会在任何人尝试安装这个包的时候得到警告 例如:npm deprecate <包名> '这个包我已经不再维护了哟~'
【注意】如果报权限方面的错,加上--force
4.卸载npm包
若要卸载之前在本地安装(在 node_modules 文件夹使用 npm install <package-name>)的软件包,则从项目的根文件夹(包含 node_modules 文件夹的文件夹)中运行:
npm uninstall <package-name>
如果使用 -S 或 --save 标志,则此操作还会移除 package.json 文件中的引用。
如果程序包是开发依赖项(列出在 package.json 文件的 devDependencies 中),则必须使用 -D 或 --save-dev 标志从文件中移除:
npm uninstall -S <package-name>
npm uninstall -D <package-name>
如果该软件包是全局安装的,则需要添加 -g 或 --global 标志:
npm uninstall -g <package-name>
可以在系统上的任何位置运行此命令,因为当前所在的文件夹无关紧要。
参考文档 Reference
1.W3Cschool关于NPM系统的知识W3Cschool: npm 发布 publish_w3cschool
2.知乎:用户:大前端开发 一分钟教你发布npm包 - 知乎 (zhihu.com)