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 删除包

相关推荐
梅孔立19 小时前
Codex 完整教程(Node.js安装 + npm安装Codex + DeepSeek配置 + 快捷键 + 设置)
前端·npm·node.js
晚风醉蝶20 小时前
webpack 模块提取
前端·webpack·node.js·ast·逆向分析
YIAN2 天前
从 SSE 流式到结构化输出:LangChain 三大 OutputParser 与 ToolCall 方案全实战
前端·langchain·node.js
濮水大叔2 天前
Cabloy全栈框架的两个SSR入口:Vona集成式SSR vs Zova独立式SSR
typescript·node.js·全栈
怕浪猫2 天前
DeepSeek Harness 系列图解
面试·前端框架·node.js
百万蹄蹄向前冲2 天前
双端同步!云服务器装最新Node.js v26.10全过程追踪
服务器·人工智能·node.js
前端snow2 天前
ai agent--- 后端概念补充:Docker Compose、ElasticSearch、IK、BM25等
node.js
EdgeEcho2 天前
Node 里那个"只解第一帧"的坑,我用 172 行代码绕过去了
node.js
光影少年2 天前
Redis + Node 如何支撑百万级并发
redis·后端·node.js
半个落月2 天前
从“等待整段答案”到边生成边展示:大模型流式输出与 SSE 实战(上)
langchain·node.js