美文网首页
私有npm包发布流程

私有npm包发布流程

作者: 咸鱼plus | 来源:发表于2019-09-26 10:45 被阅读0次

前置准备:变更依赖包源

安装nrm源管理工具并使用私有源http://127.0.0.1:9999/repository/NPM-repo-group/

npm config set registry https://registry.npm.taobao.org
npm i -g nrm
nrm add myNpm http://127.0.0.1:9999/repository/NPM-repo-group/
nrm use myNpme

创建npm包

先创建对应包的文件夹,然后使用以下命令生成 package.json 配置信息

npm init

输入命令后会出现提示输入包名称(默认会以所在文件名来命名),可以一直按回车,然后打开文件编辑,基础配置如下:

必要字段
  • name:包名(全部小写,没有空格,可以使用下划线或者横线),事前需要验证一下是否已经重名的包存在,验证方法是在命令行里使用yarn(yarn add 包名)或npm来安装一下,看是否已经存在同名的包。

  • version: 包版本号(默认1.0.0)

  • 私有源的包名可以统一以my-为开头

其他字段
  • author :作者
  • main :程序入口文件,一般直接为 index.js
  • description :描述信息,有助于搜索
  • keywords :[] 关键字,有助于在人们使用 npm search 搜索时发现项目
  • scripts :脚本,默认是一个空的 test
  • license :默认为 MIT
  • bugs :当前项目的一些错误信息,如果有的话可列出
  • dependencies :在生产环境中需要用到的依赖
  • devDependencies :在开发、测试环境中用到的依赖
  • repository :代码仓库
包文件基础结构

index.js

module['exports'] = require('./lib')

/lib/index.js

export default {
    value: '',             // 自定义值
    send: function() {},   // 自定义方法
    ......
}

包发布流程

将npm源切换为NPM-repo-group

npm set registry http://127.0.0.1:9999/repository/NPM-repo-group/

登录npm账号(部分npm版本直接使用npm login命令登录时不生效)

npm login -registry http://127.0.0.0:9999/repository/NPM-repo-hosted/
或
npm login --registry=http://127.0.0.7:9999/repository/NPM-repo-hosted/

发布程序包到NPM-repo-hosted

npm publish -registry http://127.0.0.0:9999/repository/NPM-repo-hosted/
  • 当发布成功后,会返回提示,内容是你的包名称前会有个“+”号,后面会@版本号
  • 发布前,要确认包版本号比上一个版本号要高,需要修改package.json中的version
  • 当出现错误时有几种情况需要检查:
    • 1是否包名称已被人使用(npmjs网上)
    • 2是账号是否失去发布权限
    • 3是发布的源位置上并没有该账号

发布前对包进行测试,验证包正确性

将编写好的包放进项目的node_module文件夹里面,然后在你的项目里面就可以直接引用:

import pag from 'npm包名'
或
var pag = require('npm包名');

测试完确定没有什么bug之后再执行 npm publish 进行发布


包说明文档:README.md

需要在包里面添加一个README.md文件,然后编写该包的使用文档,编写语法具体参考makedown语法


发布时会被忽略的文件

.git
CVS
.svn
.hg
.lock-wscript
.wafpickle-N
.*.swp
.DS_Store
._*
npm-debug.log
.npmrc
node_modules
config.gypi
*.orig

\color{red}{文中的127.0.0.1:9999需要换成自己的服务器的域名/ip}


nrm基础命令

查看当前源列表:

nrm ls

添加源:

nrm add 源别名 源地址

使用源:

nrm use 源别名

相关文章

  • 私有npm包发布流程

    前置准备:变更依赖包源 安装nrm源管理工具并使用私有源http://127.0.0.1:9999/reposit...

  • npm包发布流程

    npm包发布流程 标签(空格分隔): Node.js npm包发布流程 注册npm账号 方式一:去npm官网注册 ...

  • npm 私有服务器搭建和使用

    npm 私有服务器搭建和使用 作用 可以通过权限管理发布私有包,保障发布包的私密性 可以同步官方仓库,提高包安装速...

  • 发布npm包流程

    准备 准备https://www.npmjs.com 注册一个账号 安装node、npm 1.添加npm账号,登录...

  • npm包发布流程

    最近发布npm包的过程中,发现npm有很多对整个流程很友好的命名 包的定义 包的版本更新 beta、aplha版本...

  • npm包发布流程

    准备工作 在webpack配置的output参数中配置好library和libraryTarget,示例: 修改p...

  • npm包发布流程

    npm包发布流程 1. 注册npm账号 方式一: 通过npm官网注册 方式二: 通过终端注册 查看npm当前使用的...

  • npm 发布包流程

    package.json 配置说明:https://docs.npmjs.com/cli/v6/configuri...

  • 发布npm包流程

    1.到npm官网 https://www.npmjs.com[https://www.npmjs.com]注册账号...

  • 发布NPM包基本流程

    建立npm账号创建一个文件夹testnpm init第一次发布npm包执行,npm adduser否则npm lo...

网友评论

      本文标题:私有npm包发布流程

      本文链接:https://www.haomeiwen.com/subject/svpguctx.html