百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 博客教程 > 正文

什么是npm系列:三、如何发布自己的npm包

connygpt 2024-09-08 13:27 5 浏览

读完本篇文章后,你可以学到”如何开发”、“如何配置”、”如何发布”,最终可以开发属于你自己的npm包。

1. 初始化npm

通过npm init命令可以创建初始项目,需要逐步完善一下信息:

package name: (npmtest)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)

创建完package.json之后,我们就可以轰轰烈烈的写代码了。

2. 开发Tips

2.1 调试

开发中如何调试是一个痛点,很多人会把代码复制到node_modules中再调试结果,其实我们有更好的办法:”npm link”,使用流程如下:

  1. 在包根目录执行npm link
  2. 在项目中执行npm link package-name
  3. 这个时候在项目中实时访问到package-name

目前这种方式在yarn中无法使用。

3. 发布

3.1 创建/登录账号

首先需要在https://www.npmjs.com/signup注册账号。

完成之后在终端中执行npm login,输入账号密码之后即登录成功。

这里有一点需要注意,如果之前设置taobao源,需要修改为npm registry,可以使用如下指令还原:

npm config set registry http://registry.npmjs.org

但是鉴于实际情况,我们在taobao和npm源之间互相切换其实太麻烦了,比较好的解决方案就是配置package.json中的publishConfig字段,具体信息看下一段落。

3.2 package.json 配置

该项配置主要包含下面内容:

  • publishConfig
  • main
  • files

publishConfig

"publishConfig": {
 "registry": "https://registry.npmjs.org/",
 "tag": "beta",
 "access": "public"
}
  • registry 源地址
  • tag 发布对应的dist-tag标签
  • access 如果是scoped包,一定需要设置为public(付费用户除外)

main

包的入口文件,通常我们会指定为index.js。

files

我们需要控制npm包的大小,避免安装过程中花费太多时间。一般来说我们只输出编译过的内容、文档、样式等。

package.json的files字段的意思便是包含在项目中的内容,它允许设置为文件、文件名组成的数组。

除此之外,我们还可以在根目录或子目录下创建.npmignore文件,写法和gitignore一致。

当然为了完整性,有些内容是无法忽略的:

  • package.json
  • README
  • CHANGES / CHANGELOG / HISTORY
  • LICENSE / LICENCE
  • NOTICE
  • The file in the “main” field

下面这些内容是默认忽略的:

  • .git
  • CVS
  • .svn
  • .hg
  • .lock-wscript
  • .wafpickle-N
  • .*.swp
  • .DS_Store
  • ._*
  • npm-debug.log
  • .npmrc
  • node_modules
  • config.gypi
  • *.orig
  • package-lock.json

3.3 版本管理

版本号遵循语义化版本的规则,由MAJOR.MINOR.PATCH组成,在末尾还可以加上pre-release预发布版本号信息。

  • MAJOR:当你做了不兼容的 API 修改,
  • MINOR:当你做了向下兼容的功能性新增,
  • PATCH:当你做了向下兼容的问题修正。

版本号可以手动修改,也可以通过npm version命令自动修改:

// 初始版本号 v1.0.0
npm version patch
// v1.0.1
npm version prepatch
// v1.0.2-0
npm version minor
// v1.1.0
npm version major
// v2.0.0

npm version的完整命令如下:

npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]

如果我们要生成1.0.0-alpha.1风格的版本号,可以带上参数--preid:

npm version prerelease --preid=alpha

当我们执行了npm version之后,脚本会自动修改版本号,并在git中创建提交和标签,如果想要禁用该行为,可以传入--no-git-tag-version来阻止。

3.4 tag

npm的tag是用于标记不同用途的版本,一个npm包至少会有latest标签,我们可以根据测试版、预览版等不同需求定制标签。

比如如果我们有一个测试版本要发布,我们可以指定dist tag为beta:

npm publish --tag beta

当我们测试完成,准备正式发布的时候,就可以把beta对应版本号演进到latest上。

3.5 发布

当一切准备就绪之后,我们就可以进入发包的冲刺了。

npm publish

注意!可能有人说我为什么看到的只有错误,一般这个时候可以这样排查:

  • registry检查是否正确
  • 包名是否为@somescope/somepackagename形式,同时是贫穷玩家
  • 版本号是否未更新

如果包属于某个组织下,即@somescope/somepackagename形式的包名,执行命令需要调整为npm publish --access public。

经过千辛万苦之后,我们终于发布成功了,可是如果我们发现某个文件漏掉了,再发布一个版本也不太值得,我们就可以使用npm unpublish命令取消24小时之内发布的包,需要注意的是unpublish并不推荐使用。

4. 最佳实践

  • semantic-release 自动生成changelog以及版本管理
  • 代码规范+commit规范 magic-lint
  • cgr 切换npm、yarn源

5. 场景讲解

  • 每次发布操作流程
  • 移除tag

5.1 每次发布流程

  1. ?开发功能,并提交代码
  2. npm version major or minor or patch
  3. npm publish

5.2 移除tag

npm dist-tag rm <pkg> <tag>

相关推荐

自学Python,写一个挨打的游戏代码来初识While循环

自学Python的第11天。旋转~跳跃~,我~闭着眼!学完循环,沐浴着while的光芒,闲来无事和同事一起扯皮,我说:“编程语言好神奇,一个小小的循环,竟然在生活中也可以找到原理和例子”,同事也...

常用的 Python 工具与资源,你知道几个?

最近几年你会发现,越来越多的人开始学习Python,工欲善其事必先利其器,今天纬软小编就跟大家分享一些常用的Python工具与资源,记得收藏哦!不然下次就找不到我了。1、PycharmPychar...

一张思维导图概括Python的基本语法, 一周的学习成果都在里面了

一周总结不知不觉已经自学Python一周的时间了,这一周,从认识Python到安装Python,再到基本语法和基本数据类型,对于小白的我来说无比艰辛的,充满坎坷。最主要的是每天学习时间有限。只...

三日速成python?打工人,小心钱包,别当韭菜

随着人工智能的热度越来越高,许多非计算机专业的同学们也都纷纷投入到学习编程的道路上来。而Python,作为一种相对比较容易上手的语言,也越来越受欢迎。网络上各类网课层出不穷,各式广告令人眼花缭乱。某些...

Python自动化软件测试怎么学?路线和方法都在这里了

Python自动化测试是指使用Python编程语言和相关工具,对软件系统进行自动化测试的过程。学习Python自动化测试需要掌握以下技术:Python编程语言:学习Python自动化测试需要先掌握Py...

Python从放弃到入门:公众号历史文章爬取为例谈快速学习技能

这篇文章不谈江流所专研的营销与运营,而聊一聊技能学习之路,聊一聊Python这门最简单的编程语言该如何学习,我完成的第一个Python项目,将任意公众号的所有历史文章导出成PDF电子书。或许我这个Py...

【黑客必会】python学习计划

阅读Python文档从Python官方网站上下载并阅读Python最新版本的文档(中文版),这是学习Python的最好方式。对于每个新概念和想法,请尝试运行一些代码片段,并检查生成的输出。这将帮助您更...

公布了!2025CDA考试安排

CDA数据分析师报考流程数据分析师是指在不同行业中专门从事行业数据搜集、整理、分析依据数据作出行业研究评估的专业人员CDA证书分为1-3级,中英文双证就业面广,含金量高!!?报考条件:满18...

一文搞懂全排列、组合、子集问题(经典回溯递归)

原创公众号:【bigsai】头条号:程序员bigsai前言Hello,大家好,我是bigsai,longtimenosee!在刷题和面试过程中,我们经常遇到一些排列组合类的问题,而全排列、组合...

「西法带你学算法」一次搞定前缀和

我花了几天时间,从力扣中精选了五道相同思想的题目,来帮助大家解套,如果觉得文章对你有用,记得点赞分享,让我看到你的认可,有动力继续做下去。467.环绕字符串中唯一的子字符串[1](中等)795.区...

平均数的5种方法,你用过几种方法?

平均数,看似很简单的东西,其实里面包含着很多学问。今天,分享5种经常会用到的平均数方法。1.算术平均法用到最多的莫过于算术平均法,考试平均分、平均工资等等,都是用到这个。=AVERAGE(B2:B11...

【干货收藏】如何最简单、通俗地理解决策树分类算法?

决策树(Decisiontree)是基于已知各种情况(特征取值)的基础上,通过构建树型决策结构来进行分析的一种方式,是常用的有监督的分类算法。决策树算法是机器学习中的一种经典算法,它通过一系列的规则...

面试必备:回溯算法详解

我们刷leetcode的时候,经常会遇到回溯算法类型题目。回溯算法是五大基本算法之一,一般大厂也喜欢问。今天跟大家一起来学习回溯算法的套路,文章如果有不正确的地方,欢迎大家指出哈,感谢感谢~什么是回溯...

「机器学习」决策树——ID3、C4.5、CART(非常详细)

决策树是一个非常常见并且优秀的机器学习算法,它易于理解、可解释性强,其可作为分类算法,也可用于回归模型。本文将分三篇介绍决策树,第一篇介绍基本树(包括ID3、C4.5、CART),第二篇介绍Ran...

大话AI算法: 决策树

所谓的决策树算法,通俗的说就是建立一个树形的结构,通过这个结构去一层一层的筛选判断问题是否好坏的算法。比如判断一个西瓜是否好瓜,有20条西瓜的样本提供给你,让你根据这20条(通过机器学习)建立起...