极简NPM发包流程

极简Npm发包流程

快速在npm官网发布一个packge安装使用

Step1: 注册Npm账号并在本地执行如下bash指令

#https://www.npmjs.com/signup
npm adduser
npm login

Step2: 创建一个仓库

包名: tiny

md tiny
cd tiny && touch package.json
#也可以用npm init -y

编辑 package.json

package.json [name, version] 是必须的

很多情况下包名已被占用比如tiny在npm上已经发布了，所以我们使用scoped package.在自己的用户名域下创建包。

{
  "name": "@z5239235/tiny",
  "version": "1.0.0",
  "description": "Removes all spaces from a string",
  "license": "MIT",
  "repository": "feifeirun97/tiny",
  "main": "index.js",
  "keywords": [
    "tiny",
    "npm",
    "package",
    "feifeirun97"
  ]
}
//在package.json中配置好license,name,version,github仓库地址等

module.exports = function tiny(string) {
  if (typeof string !== 'string') throw new TypeError('Tiny wants a string!');
  return string.replace(/\s/g, '');
};
//index.js代码

vim package.json
npm publish --access=public
#access=public表示对所有人开放

到此为止，打包发布完成。

Step3：维护Redeme

可以通过shields添加版本信息和包的大小信息

Step4：安装使用包

回到npm官网即可看到你发布的包，已经可以在项目中使用了

#安装
$ npm install @bamblehorse/tiny

//使用
const tiny = require("@bamblehorse/tiny");

tiny("So much space!");
//=> "Somuchspace!"

tiny(1337);
//=> Uncaught TypeError: Tiny wants a string!
//    at tiny (<anonymous>:2:41)
//    at <anonymous>:1:1