npm发包指南

创建和初始化包

可以直接参考 使用 vite 创建 JS 库

如果希望创建 scoped 包则可以使用以下命令：

# my-username 替换成你npm真实的用户名
npm init --scope=@my-username

发布包

开发完毕之后，就可以发包了。但是现在所有包现在都需要双因素认证（2FA）或启用绕过 2FA 的细粒访问令牌 ，才能创建和发布包。

我们这里就以如何启用绕过 2FA 的细粒访问令牌（以下简称 token）为例说明如何发包。

1、创建 token

首先你得注册一个 npm 账号，这里不赘述。登录 npm 账号，在页面右上角点击你的头像，弹出菜单中点击 ACCESS TOKENS。

进入到 token 列表页面，点击页面上的“Generate New Token” 按钮进入到创建新 token 页面，如下所示：

这里最重要的是勾选 “Bypass two-factor authentication(2FA)”复选框。还有就是 Permissions 下拉框中根据需要选择 token 的权限。

信息填写完毕后点击“Generate Token” 按钮生成 token，注意保存 token，首次可见，以后就看不见了。

2、配置 token

在项目目录中创建一个 .npmrc 文件，里面加入一下内容：

//registry.npmjs.org/:_authToken=npm_HRKwWIOw6Ixs7Wn6SSAhSbbxxxxxx

注意将 npm_HRKwWIOw6Ixs7Wn6SSAhSbbxxxxxx 这一段替换成你刚刚申请的 token。

3、package.json 中配置一个发包命令

"scripts": {
    "release": "npm publish --access public"
}

发包是可以运行 npm run release 即可。其中 --access public 不是必须的，只有 scoped 包才有必要。

参考文档

• Creating and viewing access tokens
• Creating and publishing scoped public packages