如何发布一个npm包

73 阅读1分钟

步骤

  • 首先需要创建一个npm账号:www.npmjs.com/signup

  • 完成帐号注册后需要在终端进行登录:

    • 使用指令:npm login(注意需要切换为npm官方镜像,使用nrm或使用npm config set registry https://registry.npmjs.org

    • 按照提示键入帐号信息

  • 使用npm init完成项目初始化

  • 完成自己的项目

  • 配置package.json文件

    • "name"配置为需要发布的包名,为了避免包名冲突,使用@用户名/包名的方式命名这个npm包,允许我们将已经被其他包使用的名称作为包名

    • "version"配置npm包的版本号

    • "keywords"配置这个npm包的关键字,会展示在npm包介绍的底部,例如关键字为:["web-app", "utils"],在npm网站上会在底部展示:

image.png

  • 注意别忘了写一份README.md文件来介绍这个npm包的作用

  • 最后使用指令npm publish --access=public就可以发布这个npm包了

如何让npm包既支持CommonJS又支持ES6Module?

方法貌似挺多,但是总结了一个较为简单的方法,适用于简单项目:

使用.cjs文件来写符合CommonJS规范的代码,使用.mjs文件写符合ES6Module规范的代码,并在pakage.json中指定两种模块规范的入口文件:

  • "main"用于指定CommonJS的入口文件

  • "module"用于指定ES6Module的入口文件

例如:

image.png