入口文件
-
自定义依赖模块:
-
模块是在
package.json
里通过main
字段定义这个包对外裸露的入口;- 模块起源于
node
,语法默认反对commonjs
标准 - 模块若应用
ES Module
语法书写,通过module
字段定义入口(须要打包工具配合应用)
- 模块起源于
-
-
自定义命令行:
- 如果是提供命令行工具,则须要通过
pkg#bin
字段来定义裸露的命令名称与理论执行的文件
- 如果是提供命令行工具,则须要通过
这篇文章讲述自定义命令行的申明,NPM 依赖包请查看链接: 自定义 NPM 包。
开发环境
- [] 主动日志
- [] 版本更新
~ 应用的是 husky6+,配置与旧版本不同,追随文章操作时,请留神版本~
-
husky
- 装置
npm install husky --save-dev npx husky install
-
配置
run-script
:装置依赖后主动启动Git hooks
"prepare": "husky install"
-
追加测试钩子
# Unix 零碎可用 npx husky add .husky/pre-commit "npm run test" # Windows 通过以下命令创立文件(引号在 windows 命令行中不是标准的语法) npx husky add .husky/pre-commit # Windows 环境下找到新建的文件,编辑文件,指定命令 #!/bin/sh . "$(dirname"$0")/_/husky.sh" npm run test
-
-
commitlint
-
commitlint
提交信息校验工具-
须要和校验标准配合应用,官网默认标准
@commitlint/config-conventional
—— 校验标准可自定义。npm i -D commitlint @commitlint/config-conventional
-
-
commitlint
绑定@commitlint/config-conventional
# Unix echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js # Windows echo module.exports = {extends: ['@commitlint/config-conventional']} > commitlint.config.js
-
配置
Git hook
:在提交commit msg
进行参数校验 —— 写在run-script
中有效# Unix 零碎可用 npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1" # Windows 通过以下命令创立文件(引号在 windows 环境中不是标准的语法) npx husky add .husky/commit-msg # Windows 环境下找到新建的文件,编辑文件,指定命令 #!/bin/sh . "$(dirname"$0")/_/husky.sh" npx --no-install commitlint --edit $1
-
-
standard-version
- 装置依赖
npm i --save-dev standard-version
-
配置
run-script
:公布前主动降级版本号 + 生成日志 + 提交 Git"prepublishOnly": "standard-version && git push --follow-tags origin master"
Note: 这里不要应用
prepublish
钩子,该钩子在npm i
时运行,而不是npm publish
时运行。
调试
-
进入本地
NPM
包npm link
创立软链接到全局node
环境中
-
进入需引入依赖包的我的项目 A 中
npm link <packageName>
建设软链接依赖
-
在命令行切换到我的项目 A 目录构造下
# 调用 npx <packageName> -h
开发
NPM
包是 commonJS
语法,应用 require()
,而非import...from...
引入依赖。
而,若 NPM
包语法应用 ES6+
语法书写,必须应用 ES Module
的import
、export default
导出形式,不要混用
举荐几个罕用的命令行辅助工具:
-
shelljs
- 执行脚本程序
-
inquirer
- 命令行用户交互界面
-
chalk
- 命令行日志款式
- 可嵌套、可链式
-
commander
- 自定义命令行参数
组织构造
|- .husky
|- bin
|- actv2-use.js // 单文件命令
|- actv2.js // 入口文件,仅做直达作用
|- lib
|- actv2.js // 主文件
|- .gitignore
|- .npmrc
|- package.json
|- README.md
package.json
配置
{
"name": "actv2",
"version": "1.0.0",
"description": "","bin":"bin/actv2.js","main":"lib/actv2.js","scripts": {"prepare":"npx husky install","prepublishOnly":"standard-version && git push --follow-tags origin master","test":"echo \"Error: no test specified\" && exit 1"},"keywords": [],"author":"",
"license": "ISC",
"devDependencies": {
"@commitlint/config-conventional": "^13.2.0",
"commitlint": "^13.2.1",
"husky": "^7.0.2",
"standard-version": "^9.3.1"
},
"dependencies": {
"chalk": "^4.1.2",
"commander": "^8.2.0",
"fs-extra": "^10.0.0",
"inquirer": "^8.2.0",
"shelljs": "^0.8.4"
}
}
入口文件
入口文件示例:
#!/usr/bin/env node
var {program} = require('commander')
program
.command('add')
.argument('<module>', '新增我的项目模块')
.option('-y, --yes', '将该模块设置为部署模块')
.action((moduleName, options) => {require('..')().add(moduleName, options)
})
program
.command('use <module>', '指定部署模块')
.alias('u')
program
.option('-V, --version', '查看版本')
.helpOption('-h, --help', '查看应用帮忙');
program.parse(process.argv)
var opts = program.opts()
if (opts.version) {
process.stdout.write('actv2' + require('../package.json').version + '\n')
} else {
process.stdout.write(
'actv2\n' +
'\n' +
'Options:\n' +
'--version Show version number\n' +
'--help Show help\n' +
'\n' +
'Usage:\n' +
'actv2 --help\n'
)
}
其中,#!/usr/bin/env node
是必填行,在装置命令行后,根据该行指定 node
环境执行该命令行。
#!/bin/sh
basedir=$(dirname "$(echo"$0"| sed -e's,\\,/,g')")
case `uname` in
*CYGWIN*|*MINGW*|*MSYS*) basedir=`cygpath -w "$basedir"`;;
esac
if [-x "$basedir/node"]; then
"$basedir/node" "$basedir/../actv2/bin/actv2.js" "$@"
ret=$?
else
node "$basedir/../actv2/bin/actv2.js" "$@"
ret=$?
fi
exit $ret
vs. 缺失#!/usr/bin/env node
#!/bin/sh
basedir=$(dirname "$(echo"$0"| sed -e's,\\,/,g')")
case `uname` in
*CYGWIN*|*MINGW*|*MSYS*) basedir=`cygpath -w "$basedir"`;;
esac
"$basedir/../actv2/lib/run.js" "$@"
exit $?
参数解析
借助 commander
第三方工具包
-
申明
program.option('') // 可选参数 program.requiredOption() // 必填参数 program.requiredOption('-c, --cheese <type>', 'pizza must have cheese'); // <type> 值必填,[type]值可选
-
解析
program.parse(process.argv)
-
取值
program.opts().name program.getOptionValue(<name>)
子命令
借助 commander
第三方工具包
申明形式
-
绑定
action
的command
申明-
command
申明只有 一个参数// 示例 program .command('clone <source> [destination]') // 首行,仅有一个参数 .description('clone a repository into a newly created directory') .option('-y, --yes', 'options.yes') .action((source, destination, options, command) => {console.log('clone command called'); });
-
-
独自的可执行文件
-
command
申明增加形容参数,即表明是可执行文件的申明形式# 输入以下代码的文件为入口文件 program .version('0.1.0') .command('install [name]', 'install one or more packages') // 在入口文件所在的目录下,检索 `< 入口文件名 >-install` 文件 .command('search [query]', 'search with optional query').alise('s') // 在入口文件所在的目录下,检索 `< 入口文件名 >-search` 文件 .command('update', 'update installed packages', { executableFile: 'myUpdateSubCommand'}) .command('list', 'list packages installed', { isDefault: true});
独立执行文件残缺示例:
// 申明 program .command('use <module>', 'assign module') .alias('u')
use
命令定义#!/usr/bin/env node var chalk = require('chalk'); var {program} = require('commander'); var Message = require('../config/messages') var createdFile = require('../utils/createFile') program.option('-v, --version [version]', '指定版本号', '0.0.3') // npx <commander name> use <moduleName> -v 0.0.1 program.parse(process.argv) var moduleName = program.args // 获取 <moduleName...> 列表 var {version} = program.opts() if (moduleName.length !== 1) {process.stdout.write(chalk.redBright(Message.deployOnly) + '\n') process.exitCode = 0 } else {//}
-
执行
> npx actv2 -h
Usage: actv2 [options] [command]
Options:
-V, --version 查看版本
-h, --help 查看应用帮忙
Commands:
add [options] <module>
use|u <module> 指定部署模块
help [command] display help for command
> npx actv2 add -h
Usage: actv2 add [options] <module>
Arguments:
module 新增我的项目模块
Options:
-y, --yes 将该模块设置为部署模块
-h, --help display help for command