简单制作一个npm包,并发布

  • Post author:
  • Post category:其他




大概步骤:

  • 1、登录 npm 官网(https://www.npmjs.com/),注册一个npm账号
  • 2、制作一个 npm 的包
  • 3、将包上传或更新到 npm
  • 4、在新项目中使用你已经发布的包



步骤一:登录npm官网,注册一个npm账号,然后注册完后,官网会给你发送相关的邮件,你去你的邮箱根据提示进行操作,验证通过即可



步骤二:制作一个npm的包

  • 1、创建一个文件夹,如:npmDemo1
  • 2、进入文件夹npmDemo1,执行命令:npm init,在此过程中你可以一路回车,那么此时你的包名跟你的文件夹名字一样,即:npmDemo1
  • 3、在文件夹 npmDemo1 下创建一个 index.js 文件

    index.js
exports.run = function() {
  console.log('这是一个run方法');
}



步骤三:将包上传或更新到 npm

  • 1、配置 npm 的镜像源与代理
npm config get proxy
npm config  get https-proxy
npm config set registry https://registry.npmjs.org
  • 2、在文件夹 npmDemo1 中,执行登录命令:npm login ,输入你在npm官网的账号、密码和邮箱
npm login
  • 3、登录成功后,执行命令: npm publish 来发布上传你的包(npmDemo1)
npm publish
  • 4、发布上传后,你可以去 npm 官网上查一下自己的包有没有存在

  • 在这里插入图片描述

  • 5、当你突然想起要在你已经发布的包中添加一些东西,然后进行更新:

    index.js

exports.run = function() {
  console.log('这是一个run方法');
  console.log('再次强调一句:这是一个 run 方法')
}
1、修改包的版本 package.json中的 version
2、npm login
3、npm publish



步骤四: 在新项目中使用你已经发布的包

  • 1、创建一个新的文件夹,如 test
  • 2、在test文件夹中,执行命令: npm init
  • 3、下载你发布的包 npmDemo1: npm install npmDemo1
  • 4、在文件test中创建index.js文件,使用包 npmDemo1
const npmDemo1 = require('npmDemo1');

npmDemo1.run();
  • 5、、在文件test中执行命令 node index.js ,可以看到输出:
这是一个run方法
再次强调一句:这是一个 run 方法



总结:

1、npm 包其实一个组件或者方法或文件,使用npm的发布命令publish,其实本质上就是把这些上传到npm仓库进行

统一化管理,当你在开发项目的过程中,你可以根据自己的需求把相应的包拉取到你的项目中进行使用;



2、npm 包中的package.json文件的main字段就是用来指定包的入口文件,当你在新项目中引入包:const 

npmDemo1 = require('npmDemo1') 时,就会从你项目的node_modules中寻找到 npmDemo1,找到后就会查看这

个文件下的package.json的main字段对应的入口文件,所以当你 const npmDemo1 = require('npmDemo1') 

时,就是相当于你引入这个入口文件index.js,所以npmDemo1变量就有了run方法,也就可以打印出 run方法中的内

容。



补充:npm publish时一直报错的解决方案:

  • 1、npm官网注册好账号后,是否有进行邮箱验证,如果没有,请先进行邮箱验证
  • 2、检查淘宝镜像是否是: http://registry.npmjs.org/,如果不是,可以执行下面的命令进行设置,或者使用nrm进行切换镜像源:
npm config set registry http://registry.npmjs.org/

nrm ls
nrm use npm

3、检查包名是否被使用过,如果使用过,可以修改包名(即修改package.json中的 name),再重新 npm publish



版权声明:本文为qq_37600506原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。