nodejs 如何在npm发布自己的包 <记录>

一、包结构

必要结构:

  • 一个包对应一个文件夹(文件夹名不是包名,但最好与包名保持一致,包名以package.json中的name为主)
  • 包的入口文件index.js
  • 包的配置文件package.json
  • 包的说明文档README.md

二、需要说明的文件

1.配置文件package.json

必要结构:

  • name 包的名字
  • version 包的版本号
  • main 指明包的入口文件
  • description 对包的描述
  • keywords 搜索包时生效的关键字
  • license 包的协议

包的加载机制与package.json文件息息相关

当把目录作为模块标识符,传递给require()进行加载时,有三种加载方式:

(1)在被加载的目录下查找一个叫package.json的文件,并寻找main属性,作为require()加载的入口

(2)如果目录中没有package.json文件,或main入口不存在或无法解析,则Node.js将会试图加载目录下的index.js文件

(3)如果以上两步都失败,则Node.js会在终端打印错误信息,报告模块的缺失:Error Cannot find module 'xxx'

2.说明文档README.md

使用markdown语法

三、发布包

  1. cd进入包的主目录
  2. npm login 登录npm账号
  3. npm publish 发布包(发包前确认npm服务器上不存在同名包)
  4. 发布成功后,进入npm查看个人packages

四、删除包

发布72小时内的包可以删除,被删除的包24小时内不允许再次上传
npm unpublish 包名 --force 删除包

相关推荐
zhenxin01221 小时前
2024最新版Node.js下载安装及环境配置教程【保姆级】
node.js
Hommy882 小时前
【开源剪映小助手-客户端】Node.js 集成
开源·node.js
竹林81816 小时前
在Web3前端用Node.js子进程批量校验钱包,我踩了这些性能与安全的坑
javascript·node.js
oyzz1201 天前
Windows 上彻底卸载 Node.js
windows·node.js
小霍同学1 天前
Node.js 起步指南
node.js
codingWhat1 天前
用 Express 简单Mock自助终端机读取身份证
node.js·express
回到原点的码农1 天前
TypeScript 与后端开发Node.js
javascript·typescript·node.js
skiy1 天前
Webpack、Vite区别知多少?
前端·webpack·node.js
Luna-player1 天前
npm install vue-awesome-swiper@5.0.1 swiper@7.4.1安装后,我又想全删了,怎么移除
前端·vue.js·npm
橙露2 天前
Webpack/Vite 打包优化:打包体积减半、速度翻倍
前端·webpack·node.js