1.0.5 • Published 2 years ago
@kamisiro/deploy-cli v1.0.5
前端 CI 脚手架
为了简化项目部署流程，规范部署方式，减少部署工具学习成本与容错性，保持部署的一致性、统一性、规范性与完善性。通过参考了已 有项目的部署方式，进行归纳、总结后，研发了一套针对于公司项目的部署场景，适应于现代化项目构建的脚手架。该项目的初衷是为了 解决上述相关问题。并在不失灵活性的同时在一定程度上秉持配置文件的规范与多样化。
安装
npm i -D @kamisiro/deploy-cli
脚手架运行命令行
在命令行通过 kamisiro-deploy-cli -h 可以获取相关帮助信息
Usage: kamisiro-deploy-cli [Options] Or kamisiro-deploy-cli <command> [options]
Options:
-v, --version 查询版本号
-h, --help 显示帮助
--debug 输出详细日志
Commands:
init 通过命令行创建文件
init -d 静默创建默认文件
init -d --debug 静默创建默认文件并输出详细日志
deploy 部署默认环境应用
deploy --mode=prod 部署prod环境应用
deploy --mode=prod --debug 部署prod环境应用并输出详细日志npx kamisiro-deploy-cli -v 获取版本信息
调用命令
init 生成部署配置文件
kamisiro-deploy-cli init通过控制台进行交互方式生成配置文件kamisiro-deploy-cli init -d通过默认参数生成配置文件
deploy 执行部署命令
kamisiro-deploy-cli deploy通过加载 deploy.config.js 文件当做配置文件执行部署命令kamisiro-deploy-cli deploy --mode=prod通过加载 prod.deploy.config.js 文件与 deploy.config.js 文件进行合并处理后当 做配置文件执行部署命令kamisiro-deploy-cli deploy --mode=prod --host=127.0.0.1 --port=22 --username=root --password=123 --privateKey=key --passphrase=123可通过参数注入覆盖配置文件内部的配置
配置文件
配置文件如下规则
interface ConfigOptions {
// 项目名称
projectName: string
// 环境名称
platformName: string
/**
* 打包命令
* 为了针对不同项目执行一些定制化打包操作，现制定了打包规则与逻辑
* 如果为普通项目 则直接执行npm run build即可
* 如果为lerna或pnmpm项目 会有复数项目存在，这种情况下单执行一个命令可能无法满足各种需求
* 因此写了如下规则来应对需要
* 对于lerna或pnpm项目 则把script参数改为数组形式
* [
* {
* path: 'canghai_project' || 'packages/canghai_project',
* command: 'npm run build'
* },{
* pattern: /canghai_[a-zA-Z]+$/ || /packages\/canghai_[a-zA-Z]+$/,
* command: 'npm run build:ym',
* exclude: ['canghai_project']
* },{
* pattern: /canghai_[a-zA-Z]+123$/ || /packages\/canghai_[a-zA-Z]+123$/,
* command: 'npm run build:ym',
* exclude: [/^canghai_[a-zA-Z]+$/]
* },{
* other: true,
* command: 'npm run build:ys',
* },
* {
* path: '*',
* command: 'npm run build'
* }
* ]
*
* 这为包含所有场景的情况
* path与pattern为互斥项 两者只能二选一 如果同时存在将抛出错误
* pattern和path 与 other也为互斥项 两者只能二选一 如果同时存在将抛出错误
* path值为2种形式 一种是直接写死的项目文件名 这种情况会精确匹配到该文件路径
* 另一种形式是写为 * 该情况下会对lerna.json或pnpm里内定义的包路径下的所有项目执行相同命令
* pattern 为正则匹配，可以通过正则规则匹配符合条件的文件名 执行对应脚本
* other 值只能为true 否则不执行对应脚本 该参数逻辑为对前面表达式所有未命中的项执行该操作 可通过exclude再进行排除
*
* [{
* path: 'canghai_project',
* command: 'npm run build'
* },{
* other: true,
* command: 'npm run build:ys',
* },{
* pattern: /^canghai_[a-zA-Z]+123$/,
* command: 'npm run build:ym',
* }{
* other: true,
* command: 'npm run build:ys',
* },]
* other值还有个作用 可以像这种方式多次执行 每执行完一个other选项后会清空文件的命中列表，方便多次执行的场景
* exclude 为排除项 为数组形式 值为2种形式 一种是直接字符串形式 一种是正则表达式 如果exclude的值和当前的pattern或path相同也会抛出错误
* fileName(name: string, command: string) 该命令为可以给予打包后的文件夹重命名，为了避免一个项目多次打包的场景存在 需要对打包后的文件夹重命名
* postScript 后置脚本 string | string[] 打包执行完成后执行一些操作,如果和 下方的postScript同时存在 则script的postScript优先级更高
* serverScript 服务器执行脚本 string | string[] 服务器部署完成后执行一些操作,如果和 下方的serverScript同时存在 则script的serverScript优先级更高
*/
script: string | ScriptType[]
// 是否调用打包命令前执行npm i 一般用作于ci环境
// 如果为'npm' | 'yarn' | 'pnpm' 则调用对应的包管理器进行安装
// 如果为false 则不进行安装 如果为true 则搜索lock文件 通过lock文件对应的包管理器进行安装 否则使用npm进行安装
install: boolean | 'npm' | 'yarn' | 'pnpm'
// 打包执行完成后后置命令 用于在打包完成后执行一些后置处理什么的
postScript: string | string[]
// 本地打包生成目录
outputPath: string
cosType: 'tencent' | 'aliyun'
// cosSecretId(如果填写该项目则为cdn项目)
secretId?: string
// cosSecretKey(如果填写该项目则为cdn项目)
secretKey?: string
// cos桶名称
bucket: string
// cos地域
region: string
// cos上传目录
cosUploadPath: string
// 是否上传到cos之前先清除原本目录
isRemoveCosFile: boolean
// 获取临时密钥函数
getTempAuthInfo?: () => CosTempAuthType
// 服务器地址
host: string
// 服务器端口号
port: number
// 用户名
username: string
// 密码(和私钥二选一)
password: string
// 本地私钥路径(和密码二选一)
privateKey: string
// 本地私钥密码(如果私钥没设密码留空即可)
passphrase: string
// 服务器部署路径
serverPath: string
// 是否备份服务器原文件
isBakFile: boolean
// 备份的文件名
bakFileName: string | ((name: string) => string)
// 是否部署前先删除服务器原文件
isRemoveServerFile: boolean
// 在文件部署完成后执行一些服务器脚本
serverScript: string | string[]
}example
更多配置信息请到@kamisiro/deploy-cli/lib/types/type.d.ts里查看
module.exports = {
"projectName": "ant-design-pro",
"platformName": "",
"script": "npm run build",
"isInstall": false,
"scriptPost": "echo 1234",
"host": "你的服务器ip",
"port": 22,
"username": "你的服务器用户名",
"password": "你的服务器密码",
"privateKey": "你的私钥路径",
"passphrase": "",
"isRemoveCosFile": false,
"secretId": "你的cosId",
"secretKey": "你的cosKey",
cosUploadPath: '/temp/',
bucket: '你的cos桶名称',
region: '你的地域',
"outputPath": "dist",
"serverPath": "/test",
"isBakFile": true,
"bakFileName": "",
"isRemoveServerFile": true,
"serverScript": "echo success"
}example2:
更多配置信息请到@kamisiro/deploy-cli/lib/types/type.d.ts里查看
module.exports = {
"projectName": "ant-design-pro",
"platformName": "",
"script": [{
pattern: /app[0-9].*$/,
command: "npm run build",
fileName(name, command) {
const split = command.split(' ')
return name + '_' + split[split.length - 1]
},
"postScript": "echo 123",
}, {
path: "demo1",
command: "npm run build",
fileName(name, command) {
const split = command.split(' ')
return name + '_' + split[split.length - 1]
},
"postScript": "echo 456",
}, {
other: true,
command: "npm run build",
fileName(name, command) {
const split = command.split(' ')
return name + '_' + split[split.length - 1]
},
exclude: 'demo',
"postScript": "echo 789",
}, {
path: "demo2",
command: "npm run build:test",
fileName(name, command) {
const split = command.split(' ')
return name + '_buildtest'
},
"postScript": "echo 123",
}, {
other: true,
command: "npm run build:test",
fileName(name, command) {
const split = command.split(' ')
return name + '_buildtest'
},
exclude: ['case_lib', /app[0-9].*$/],
"postScript": "echo ccccc",
}, {
other: true,
command: "npm run build:dev",
fileName(name, command) {
const split = command.split(' ')
return name + '_builddev'
},
exclude: [ /demo[0-9].*$/],
"postScript": "echo demo",
}],
"isInstall": true,
"postScript": "echo 123456",
"host": "你的服务器ip",
"port": 2789,
"username": "你的服务器用户名",
"password": "你的服务器密码",
"privateKey": "你的私钥路径",
"passphrase": "",
"isRemoveCosFile": false,
"secretId": "",
"secretKey": "",
"outputPath": "dist",
"serverPath": "/test2",
"isBakFile": true,
"bakFileName": "",
"isRemoveServerFile": true,
"serverScript": "echo 123"
}