如何在 npm 上发自己的包

前因:之前在cordova 添加插件的时候遇到一个问题 就是 插件与新版本XCode(依赖库有删减)存在不兼容的问题,但插件作者其实已在gitHub 上更新该插件版本, 只是并未更新到npm上,所以有把项目clone下来发布到自己的npm账户的想法,特此记录操作流程,以便后续在遇到此问题时候查看。

首先需要到npm 官网 https://www.npmjs.com/signup 注册一个账号, 如果有账号了可直接在命令行登录 , 


终端登录注册好的npm账号(需输入用户名、密码、邮箱)

登录的时候一定要确认自己当前npm镜像源是npm的()而不是淘宝的镜像

npm config get registry

npm config set registry=http://registry.npmjs.org

上传完后可设置回淘宝镜像(cnpm 命令),方便下载依赖库 (注意:从淘宝镜像安装所有模块时,当发现模块还没同步过来,cnpm 会自动在后台与npm 合并, 第一次会直接从npm源下载,后续在安装就直接从淘宝源直接下载安装)

npm config set registry http://registry.npm.taobao.org/

如果查看结果为淘宝镜像,按照上面的命令设置为npm源

网上有楼主说用npm的账号登录淘宝镜像会报网络错误,我测试了下,其实是可以登录的,只是登录的是cnpm的镜像,所以想要上传到npm,必须切换到npm镜像


显示登录的为淘宝镜像

接下来就是在本地创建项目了:

  选择一个文件夹目录:在终端进入该文件夹目录,执行npm init 命令

执行该命令,接着依次填写,不想填写的直接回车,也可以后续到 package.json 配置文件中修改这些配置

1.name 模块名,该名称需要在npm 上是唯一的,之后用户通过 npm install "当前模块名来引用该库",所以在定义的时候可以到 https://www.npmjs.com/ 去查询是否存在当前名字的包

2.version 版本号,语义版本号分为X.Y.Z 三位,代表主版本号,次版本号和补丁版本号,

所以当库更新时,版本号应按以下原则更新

    a. 如果只是修复bug,需要更新Z位。

    b. 如果是新增了功能,但是向下兼容,需要更新Y位。

    c. 如果有大变动,向下不兼容,需要更新X位。

3. description 介绍自己的模块

4. main 入口文件,必要, 当通过require 或 import 时,是读取main 里声明的文件

5.test command  测试命令  (给出库的一些可测试的信息)

6.git repository git 仓库地址

7.keywords  关键词,可通过npm搜索这些关键词找到你的库

8.author 作者信息 该库的开发者信息

9.license: 代码授权  (例如 Apache 2.0  或 MIT 等协议)

执行完上面命令,可在文件夹中生成一个package.json 的文件


如何在 npm 上发自己的包_第1张图片
生成的 package.json 文件

接下来就可以在该目录编写自己的代码,或者把别人库文件拿进来修改

最后:发布模块  在当前命令直接执行 npm publish  即可直接上传

有文章说:  npm 将包发布为公共包,npm修改发包模式分为私有包和公共包,需要添加–access public命令,不然会报错 我发布的时候,并不存在这个问题,大家可以酌情选择

库升级攻略:发布完之后想升级库,步骤如下:

      a.使用 npm view "库名" versions 查看远端版本, 修改包内容,修改后作为新版本进行提交

      b. 修改版本号:使用npm version 进行修改,update_type 有三个参数: patch: 这个是补丁的意思 / minor: 这个是小版本修改 / major: 这个是大版本修改

       实例:  如 1.0.1  npm version patch                                                                          

                    如 1.1.0 npm version minor

                    如 2.0.0 npm version major

         修改好后 还得  直接 npm publish 上传到远端, 就算完成

npm 部分命令 :

    a.  npm update "包名" 用于更新node_modules子目录对应模块更新到最新版本

    b. npm cache clear 可以清空 npm 本地缓存,用于处理库版本未更新,但代码更新的情况

   c. npm unpublish "包名"@版本号  可以撤销自己发布过的某个版本代码 (但npm 只能删除发布24小时内的包,发布超过24小时的 可以发布一个新版本 里面为空文件,覆盖以前的包, 然后执行npm deprecate my-thing@"< 最新版本号")  大家如要更详细可自行百度,这里只做记录

你可能感兴趣的:(如何在 npm 上发自己的包)