如何向npm上传你封装的js工具代码?


1.注册 npm 账号

npm 官网

2.检查你的 node,npm,没装的去装

node - v
npm - v

node 官网

下载后面带 LTS 的,这是长期支持的

3.开始创建

先创建一个文件夹,通过 cmd 或者在 vscode 中运行npm init,他会让你填写一些包名,包版本,包介绍等等,等你填完了他会生成一个package.json文件,里面主要是存储你的这个包信息,

不想填的话可以使用 npm init -y 来自动创建一个默认的 package.json 文件。`

4.创建入口文件 index.ts

你可以将你在其他文件写的代码导入到 index.ts 中,再从 index.ts 导入出去,代码少的话可以直接在 index.ts 中写

5.编写 page.json 文件

{
  "name": "vue-directive-throttle", // 包名,唯一的,因为需要在npm搜索
  "version": "1.9.0", // 版本号 ,每次更新,版本号都需要不一样
  "description": "Vue3通用事件节流自定义指令", // 包介绍
  "main": "index.js", // 入口文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    // 关键字
    "vue",
    "vue3",
    "directive",
    "throttle"
  ],
  "author": "lengyangwei", // 作者
  "license": "MIT" // 包遵循什么样的开源协议
}

6.README.md

一般是这个包如何使用的描述

7.发布到 npm

npm login  // 登录npm账号

注意:不要使用 taobao 镜像

npm install -g nrm   // 安装
nrm ls // 查看镜像列表
nrm use npm  // 使用npm镜像
// 如果使用nrm报错。则试一下
npx nrm ls
npx nrm use npm
npm publish --access public

**--access public**:

--access 选项用于指定包的访问级别。它可以是

  • public:任何人都可以安装和使用这个包。这是默认选项,但需要显式指定它以避免默认行为改变的风险。
  • restricted:只有你(以及你授权的其他用户)可以访问和安装这个包,通常用于私有包。

如果 npm publish –access public 一直转圈

npm 缓存问题:尝试清除 npm 缓存。可以使用命令npm cache clean --force


文章作者: 冷杨威
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 冷杨威 !
  目录
-->