手把手带你发npm包

引言:

前端微服务的流行趋势,为了能做到独立开发、独立部署,不同微服务(子项目)公用组件的使用使npm包变得不可或缺


重要概念 scope:

包的范围(作用域)

包的范围,访问级别和可见性


准备工作:

1.npm注册账号

2.如果是发布组织范围的包,需要先创建一个组织

3.仓库地址为npm,如是cnpm,用nrm切换

npm i nrm -g(安装)

nrm ls(查看仓库地址)

nrm use npm(切换)


发布包:

一.发布一个没有作用域(unscoped)的公共包

1.在命令行上,为包创建一个目录:

    mkdir my-test-package

2.导航到包的根目录:

    cd my-test-package

3.如果您使用git来管理软件包代码,请在软件包根目录中运行以下命令,替换git-remote-url为软件包的git远程URL:

    git init 

    git remote add origin git://git-remote-url

4.在程序包根目录中,运行该npm init命令,生成package.json文件

5.创建一个README文件(必须)说明您的包代码是什么以及如何使用它,和.npmignore或.gitignore文件(非必须)来阻止发布到注册表

6.编写包的代码

7.发布:在根目录输入

    npm publish

登录:由于没有登录npm,发布的时候肯定会报错,输入 npm adduser,然后根据提示输入用户名、密码和邮箱,登录之后重新发布就行了。

二.发布一个有作用域(scope)的公共包

如果您使用npmrc 管理多个注册表上的帐户,请在命令行上切换到相应的配置文件:

npmrc <profile-name>

1.在命令行上,为包创建一个目录:

    mkdir my-test-package

2.导航到包的根目录:

    cd my-test-package

3.如果您使用git来管理软件包代码,请在软件包根目录中运行以下命令,替换git-remote-url为软件包的git远程URL:

    git init

    git remote add origin git://git-remote-url

4.在程序包根目录中,运行npm init命令并将作用域传递给scope标志:

    对于组织范围的包,请替换my-org为组织的名称:

    npm init --scope=@my-org

    对于用户范围的包,请替换my-username为您的用户名:

    npm init --scope=@my-username

5.创建一个README文件(必须)说明您的包代码是什么以及如何使用它,和.npmignore或.gitignore文件(非必须)来阻止发布到注册表

6.编写包的代码

7.发布:在根目录输入

    npm publish --access public(之后的版本迭代可使用npm publish)

三.发布一个私有包

步骤和 二.发布一个有作用域(scope)的公共包 一样,但是第7是用npm publish发布。

注意:在发布私有用户范围的npm包之前,您必须注册一个付费的npm用户帐户。此外,要发布私有组织范围的包,您必须创建一个npm用户帐户,然后 创建一个付费的npm组织


安装包:

npm官网找包,然后npm-i-packageName


更新包:

更改包内容重新发布,必须要改动其version,再npm publish。

可以在package.json里直接改动version,也可以使用变更版本号的命令:npm version <major | minor | patch>

npm采用语义化版本,共三位,以’.’隔开,从左至右依次代表:主版本(major)、次要版本(minor)、补丁版本(patch)。

例如:1.0.0=》major.minor.patch


弃用包:

如果您不再希望维护包,或者您希望鼓励用户更新到新版本或不同版本,则可以弃用它。

弃用整个包:

    npm deprecate <package-name> "<message>"

弃用单个版本的包:

    npm deprecate <package-name>@<version> "<message>"


删除包(unpublish):

为了从npm注册表中永久删除包(或包版本),作为包所有者或协作者,您可以在初始发布后的72小时内从命令行取消发布它。

删除整个包:

    npm unpublish <package-name> -f

删除单个版本的包:

   npm unpublish <package-name>@<version>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,949评论 0 9
  • 本文参考:【原】npm 常用命令详解从0开始发布一个无依赖、高质量的npm包Yarn 官网 上一篇文章 npm总结...
    双面小Q阅读 2,281评论 0 6
  • NPM官方文档写的十分良心,此篇我做一些比较常用功能的积累,有些地方是翻译,有些地方省略可以去官文看。 NPM是什...
    宋乐怡阅读 2,443评论 0 2
  • 1 从前有个大侠。 大侠在成名前是个和尚。 那个年头佛教兴盛,成为和尚的渠道很多,有诚心皈依的,也有杀了人后遁入空...
    林陌鹿阅读 1,786评论 23 32
  • 日子紧挨着土地匍匐前进 照样有人在针尖上烹茶煮酒 阳光照在山巅上折射出海市蜃楼 一段梦于枕畔辜负了谁 地狱和天堂如...
    陌上冷阅读 217评论 0 0