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

相关推荐
Hello.Reader6 小时前
Flink 文件系统通用配置默认文件系统与连接数限制实战
vue.js·flink·npm
行者无疆_ty6 小时前
什么是Node.js,跟OpenCode/OpenClaw有什么关系?
人工智能·node.js·openclaw
-凌凌漆-6 小时前
【npm】npm的-D选项介绍
前端·npm·node.js
lucky67076 小时前
Windows 上彻底卸载 Node.js
windows·node.js
Android系统攻城狮8 小时前
鸿蒙系统Openharmony5.1.0系统之解决编译时:Node.js版本不匹配问题(二)
node.js·鸿蒙系统·openharmony·编译问题·5.1
清山博客8 小时前
OpenCV 人脸识别和比对工具
前端·webpack·node.js
何中应10 小时前
nvm安装使用
前端·node.js·开发工具
何中应11 小时前
MindMap部署
前端·node.js
37方寸13 小时前
前端基础知识(Node.js)
前端·node.js
朝朝暮暮an1 天前
Day 3|Node.js 异步模型 & Promise / async-await(Part 1)
node.js