whale-makelink是一个npm工具,是强业务的工具,可以将当前工程目录下的项目文件夹,在README中生成项目的链接地址。Demo。
一、npm init
使用npm init生成package.json
{ "name": "whale-makelink", "version": "1.0.5", "description": "Make-link can get all the project folders of the current directory, and generate the project link directory in the readme.", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { "type": "git", "url": "git@github.com:jingwhale/whale-makelink.git" }, "keywords": [ "makelink" ], "author": "jingwhale@yeah.net", "license": "ISC"}
二、自定义命令
2.1、在package.json的bin下定义一个对象,这里makelink就是需要的命令,内容交给index.js
{ "name": "whale-makelink", "version": "1.0.5", "description": "Make-link can get all the project folders of the current directory, and generate the project link directory in the readme.", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "repository": { "type": "git", "url": "git@github.com:jingwhale/whale-makelink.git" }, "bin": { "makelink": "./index.js" }, "keywords": [ "makelink" ], "author": "jingwhale@yeah.net", "license": "ISC"}
2.2、在index.js中添加’#!/usr/bin/env node’
#!/usr/bin/env node
const path = require('path');
const makelink = require('./makelink');
const pathName = path.resolve(__dirname, '../..');
const srcFile = pathName + '/README.md';
makelink(srcFile,pathName);
三、发布npm包
3.1、注册
npm官网注册,并且通过邮件验证后,才能发npm包。
3.2、登录
npm login
输入用户名、密码和邮箱。
3.3、发布
npm publish
3.4、版本更新
1)、变更版本号-自动改变版本
npm version
update_type为patch, minor, or major其中之一,分别表示补丁,小改,大改
若是patch,变为1.0.1
若是minor,变为1.1.0
若是major,变为2.0.0
2)、发布
npm publish
3.5、发布出错
1)、验证邮箱
2)、修正npm源
npm config get registry
npm config set registry=http://registry.npmjs.org
四、更新package.json
更新package.json后,需要先提交到github,再进行版本的升级。
创建
readme中使用
![verion](https://img.shields.io/badge/npm-1.0.8-brightgreen.svg)
策略
每次代码更新完毕,在进行版本的升级操作。
Original: https://www.cnblogs.com/jingwhale/p/10699446.html
Author: jingwhale
Title: npm包开发(whale-makelink)
原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/568675/
转载文章受原作者版权保护。转载请注明原作者出处!