入口文件
自定义依赖模块：
模块是在
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
commitlintcommitlint提交信息校验工具须要和校验标准配合应用，官网默认标准
@commitlint/config-conventional—— 校验标准可自定义。npm i -D commitlint @commitlint/config-conventional
commitlint绑定@commitlint/config-conventional# Unixecho "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js# Windowsecho 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.mdpackage.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 nodevar { 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/shbasedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")case `uname` in *CYGWIN*|*MINGW*|*MSYS*) basedir=`cygpath -w "$basedir"`;;esacif [ -x "$basedir/node" ]; then "$basedir/node" "$basedir/../actv2/bin/actv2.js" "$@" ret=$?else node "$basedir/../actv2/bin/actv2.js" "$@" ret=$?fiexit $retvs. 缺失#!/usr/bin/env node
#!/bin/shbasedir=$(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 nodevar 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.1program.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 -hUsage: actv2 [options] [command]Options: -V, --version 查看版本 -h, --help 查看应用帮忙Commands: add [options] <module> use|u <module> 指定部署模块 help [command] display help for command> npx actv2 add -hUsage: actv2 add [options] <module>Arguments: module 新增我的项目模块Options: -y, --yes 将该模块设置为部署模块 -h, --help display help for command