美文网首页
发布一个npm包,需要几步?

发布一个npm包,需要几步?

作者: 小鱼的大白话 | 来源:发表于2020-04-10 23:29 被阅读0次

npm(node package management),是nodejs内置的包管理器。中心思想是共享代码,在这里我们可以找到自己需要的包,安装,使用,当然也可以发布我们自己的包。那下面我就来说下,发布一个npm包,需要几步?


发布一个npm包比大象装冰箱麻烦一点点,也就是一点点,不信,你往下看😁:

1、注册npm账号,点我注册
2、登录账号,npm login,根据提示输入用户名和密码
3、赐名,通过 npm info +包名 来查看包信息,包名不能重复
4、初始化包
  a、创建文件夹,mkdir + 包名
  b、进入目录,cd + 包名
  c、初始化包,npm init
  d、按提示输入信息,填充包的详细信息,会生成package.js
  e、编写package.js,根据需要填充目录,安装依赖,编写代码
常见目录结构如下:

index.js代码示例🌰如下

function add (num1, num2) {
    return num1 + num2
}  

function sub (num1, num2) {
    return num1 - num2
} 

module.exports = {
    add,
    sub
};

5、编写好代码,发布, 在项目目录下npm publish即可


注意点:
1、每次发布前,需修改版本号,package.js中的version
2、js包如何兼容ts--------------提供类型声明文件(类型声明文件的主文件名与JS库文件的主文件名相同,后缀为d.ts,例如主文件名为“index.js”,则类型声明文件名为“index.d.ts”)

index.index.d.ts代码示例🌰如下:

export function add(n1: number, n2: number): number;
export function sub(n1: number, n2: number): number;

package.js增加types配置如下:

  "name": "xxxx",
  "version": "我是版本,默认1.0.0,每次发布时需要更新",
  "description": "我是包描述,帮助大家在使用npm search时找到这个包",
  "keywords": ["我是关键字","帮助大家在使用npm search时找到这个包"],
  "main": "index.js", // 我是入口文件
  "types": "index.d.ts", //我是类声明文件
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "dependencies": {},
  "devDependencies": {},
  "author": "",
  "license": "ISC"

3、删包
  a、删除某个版本: npm unpublish 包名@版本号
  b、删除整个包:npm unpublish 包名 --force

相关文章

  • 发布一个npm包,需要几步?

    npm(node package management),是nodejs内置的包管理器。中心思想是共享代码,在这里...

  • 小程序开发本地npm的使用

    开发中复用的代码通常会封装成npm包,发布到npm源,项目中再依赖这个包。如果包的源码改动,需要先发布到npm上再...

  • 如何在npm发布一个包

    发布一个npm包 1 登录 npm 2 更新包版本号 3 发布 设置npm publish 时的发布文件(有时我们...

  • 使用npm link 加速调试

    使用npm link 加速调试 我们在把包发布到npm上时,如果需要对本地的包进行修改,我们需要改变一个版本,重新...

  • 自定义npm包的创建、发布、更新和撤销

    大纲 1、准备2、自定义npm包3、发布自定义npm包4、引用npm包5、更新npm包6、撤销发布的npm包 博客...

  • 发布一个 npm 包,构建自己的第三方库

    发布一个npm包,构建自己的第三方库 前言 小生在需要发布自己npm包时,见网上诸多教程,皆无法满足所思需求;不是...

  • npm操作

    npm所有者管理: npm登录: npm查看用户信息: 发布(包): npm撤销发布的包: npm退出: 初始化n...

  • npm包发布流程

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

  • 发布npm包,删除npm包

    发布npm包 注册并在本机添加npm用户(已注册可忽略) 完成了上面的步骤之后,我们接下来要在www.npmjs....

  • npm发布包

    1. 使用npm命令登陆: 输入:Username、Password、Email 2. 在package.json...

网友评论

      本文标题:发布一个npm包,需要几步?

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