如何开发创建自己的npm包并成功发布、维护至npm官方网站

npm,全称为Node Package Manager,是专为JavaScript生态系统设计的软件包管理系统,尤其与Node.js平台紧密关联。作为Node.js的默认包管理工具,npm为开发者提供了便捷的方式来安装、共享、分发和管理代码模块。

npm作为JavaScript世界不可或缺的基础设施,极大地促进了代码复用和协作。创建自己的npm包并成功发布、维护至npm官方网站,可以连接全球范围内的开发者、包作者与使用者,共同推动着Node.js生态的繁荣与发展。

一、npm init

使用npm init生成package.json

复制代码
{
  "name": "whale-makelink",
  "version": "1.0.5",
  "description": "Make-link can get all the project folders of the current directory, and generate the project link directory in the readme.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git@github.com:jingwhale/whale-makelink.git"
  },
  "keywords": [
    "makelink"
  ],
  "author": "jingwhale@yeah.net",
  "license": "ISC"
}

二、自定义命令

2.1、在package.json的bin下定义一个对象,这里makelink就是需要的命令,内容交给index.js

复制代码
{
  "name": "whale-makelink",
  "version": "1.0.5",
  "description": "Make-link can get all the project folders of the current directory, and generate the project link directory in the readme.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git@github.com:jingwhale/whale-makelink.git"
  },
  "bin": {
    "makelink": "./index.js"
  },
  "keywords": [
    "makelink"
  ],
  "author": "jingwhale@yeah.net",
  "license": "ISC"
}

2.2、在index.js中添加'#!/usr/bin/env node'

复制代码
#!/usr/bin/env node

const path = require('path');
const makelink = require('./makelink');

const pathName = path.resolve(__dirname, '../..');
const srcFile = pathName + '/README.md';

makelink(srcFile,pathName);

三、发布npm包

3.1、注册

npm官网注册,并且通过邮件验证后,才能发npm包。

3.2、登录

复制代码
npm login

输入用户名、密码和邮箱。

3.3、发布

复制代码
npm publish

3.4、版本更新

1)、变更版本号-自动改变版本

复制代码
npm version <update_type>

update_type为patch, minor, or major其中之一,分别表示补丁,小改,大改

复制代码
若是patch,变为1.0.1
若是minor,变为1.1.0
若是major,变为2.0.0

2)、发布

复制代码
npm publish

3.5、发布出错

1)、验证邮箱

2)、修正npm源

复制代码
npm config get registry
npm config set registry=http://registry.npmjs.org

四、更新package.json

更新package.json后,需要先提交到github,再进行版本的升级。

五、版本展示

创建

readme中使用

复制代码
![verion](https://img.shields.io/badge/npm-1.0.8-brightgreen.svg)

策略

每次代码更新完毕,在进行版本的升级操作。

六、npm whale-makelink

相关推荐
Csvn14 小时前
OpenSpec 详细使用教程
前端
明月_清风14 小时前
加密解密系统完全指南:原理剖析与 Go 实践
后端
之歆15 小时前
Day19_LESS 完全指南——从入门到工程实践
前端·css·less
小江的记录本15 小时前
【JVM虚拟机】垃圾回收GC:垃圾收集器:CMS:核心原理、回收流程、优缺点、废弃原因(附《思维导图》+《面试高频考点清单》)
java·jvm·后端·python·spring·面试·maven
Meteors.15 小时前
安卓源码阅读——01.grade设置binding为true时,xml如何进行映射
android·xml
云水一下16 小时前
HTML5 从入门到精通:实战收官——从零搭建完整静态网站,综合运用所有知识
前端·html5
不总是16 小时前
Windows 系统 Node.js 免安装版(zip)安装与配置教程(2026 最新)
前端·windows·node.js
冬奇Lab16 小时前
每日一个开源项目(第105篇):Twenty - 跳出 Salesforce 的圈套,定义现代开源 CRM
前端·后端·开源
_李小白16 小时前
【android opencv学习笔记】Day 26: 滤波算法之低通滤波与图像缩放插值
android·opencv·学习
NiceCloud喜云17 小时前
Claude Code Routines 实战:三种触发器跑通云端自动化编码
android·运维·数据库·人工智能·自动化·json·飞书