npm包发布与迭代

s-alone

已于 2022-08-26 09:07:07 修改

阅读量1.4k

点赞数 2

文章标签： npm 前端 node.js

于 2022-07-29 11:30:50 首次发布

本文链接：https://blog.csdn.net/m0_65937359/article/details/126052246

版权

npm adduser

# 设置npm镜像仓库
npm config set registry https://registry.npmjs.org 

# 添加用户到.npmrc文件
npm adduser [--registry=url] [--scope=@orgname] [--always-auth] [--auth-type=legacy]

# 查看登录用户
npm whoami

npm pack

开发npm包，经过build之后需要测试，通过npm pack之后,就会在当前目录下生成一个tgz文件，可把该文件拷进项目进行测试，测试无误后可放心publish了

npm publish

npm publish [<tarball>|<folder>][--tag <tag>] [--access <public|restricted>][--otp otpcode] [--dry-run]

# 指定仓库发布
npm publish --registry=https://registry.npmjs.org/ 

# 发布有命名空间的包
npm publish --access=public
# 当你的包是以你的usename为命名空间，譬如：@salone/watermaker，npm会认为这个包是私有的，当你npm publish时会报错，这是要附上--access=public告诉npm这个包是以开放包发布的即可。
# (仅仅当发第一个版本时会要求带access=public；当npm仓库中已经存在了这个包，日常更新版本无需加access)

打包文件内容

npm publish/pack 的时候会把项目目录里面所有的文件都打包进去，但是往往有一部分目录和文件不想发布上去，比如项目的源码、编译脚本等等信息。如何发布用户需要使用的相关文件呢？

使用.gitignore设置忽略文件

**.gitignore 设置的忽略文件，在git代码管理和 npm publish **都会被忽略
使用.npmignore设置忽略文件

.npmignore 的写法跟 .gitignore 的规则完全一样。若同时使用了 .npmignore和 .gitignore，只有 .npmignore 会生效，优先级比较高。
在package.json的files字段设置包含文件

直接在 package.json 中 files 字段设置发布哪些文件或目录。这个优先级高于 .npmignore 和 .gitignore

选择哪种方法，根据自己的需求而定。一般情况，使用方法三。

默认忽略文件：

.*.swp
._*
.DS_Store
.git
.hg
.npmrc
.lock-wscript
.svn
.wafpickle-*
config.gypi
CVS
npm-debug.log
node_modules/
package.json 中main字段配置的文件(入口文件)

默认包含文件

默认被包含, 即便设置忽略也无效

package.json
CHANGELOG
README
LICENSE
入口文件

实例

{
  "name": "watermaker_shaoalong",
  "version": "1.0.8",
  "description": "",
  "main": "watermaker.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "release": "node ./config/release.js test"
  },
  "author": "shaoalong",
  "license": "ISC",
  "publishConfig": {
    "registry": "https://registry.npmjs.org" // npm发布仓库
  },
  "files": [ // 文件要包含的文件。如果不设置该字段，会把所有文件都打包进去
    "dist" // 只要dist目录下的文件
  ],
  "devDependencies": {
    "fs-extra": "^10.1.0",
    "inquirer": "^8.2.4",
    "semver": "^7.3.7",
    "standard-version": "^9.5.0"
  },
  "dependencies": {
    "@shaoalong/test": "0.0.1"
  }
}