airport2 0.0.2 → 0.0.4

package/CHANGELOG.md

@@ -1,10 +1,31 @@
 # CHANGELOG
 
+
+## [0.0.4] - 2025-06-27
+
+* 一些优化
+* 更多范例详见`example`目录
+* `run`函数默认注入父进程的`env`环境变量
+* 统一Step和Task的`run`方法，支持直接运行`Step.run`和`Task.run`
+
+
+## [0.0.3] - 2025-06-26
+
+* 日志染色，高亮关键信息，更容易区分日志信息
+* 优化部分代码，提高可读性和可维护性
+* Step添加`skip`属性，支持跳过执行，默认为`false`
+
+
+## [0.0.2] - 2025-06-26
+
+* 一些优化
+
+
 ## [0.0.1] - 2025-06-25
 
 ### 初始版本发布
-- ✅ 实现Pipeline-Task-Step三级架构
-- ✅ 支持本地命令执行和远程SSH操作
-- ✅ 添加单元测试框架和示例测试
-- ✅ 实现测试模式，支持命令预览
-- ✅ 完成基础文档和开发计划
+- 实现Pipeline-Task-Step三级架构
+- 支持本地命令执行和远程SSH操作
+- 添加单元测试框架和示例测试
+- 实现测试模式，支持命令预览
+- 完成基础文档和开发计划

package/README.md

@@ -1,6 +1,6 @@
 # Airport
 
-使用`ts`编写`Shell`管道
+使用`ts`编写流水线
 
 ```bash
 bun add airport2
@@ -32,7 +32,7 @@ bun airport.ts // 也可以将命令添加到package.json中
 
 ## Example
 
-1、常规构建发布
+**常规构建发布范例**
 
 ```ts
 import { name, version } from './package.json'
@@ -74,14 +74,13 @@ const deployTask = new Task({
 PipeLine.run([deployTask])
 ```
 
-docker构建发布:
+**docker构建范例**
 
 ```ts
 import { name, version } from './package.json'
 import { PipeLine, Task } from 'airport2'
 
-// 创建部署任务
-const deployTask = new Task({
+const dockerTask = new Task({
   name: '部署docker应用',
   steps: [
     {
@@ -95,5 +94,5 @@ const deployTask = new Task({
   ],
 })
 
-PipeLine.run([deployTask])
+dockerTask.run()
 ```

package/bun.lock

@@ -3,6 +3,9 @@
   "workspaces": {
     "": {
       "name": "ts-cicd",
+      "dependencies": {
+        "chalk": "^5.4.1",
+      },
       "devDependencies": {
         "@types/bun": "latest",
         "@types/node": "^20.12.7",
@@ -136,6 +139,8 @@
 
     "chai": ["chai@4.5.0", "", { "dependencies": { "assertion-error": "^1.1.0", "check-error": "^1.0.3", "deep-eql": "^4.1.3", "get-func-name": "^2.0.2", "loupe": "^2.3.6", "pathval": "^1.1.1", "type-detect": "^4.1.0" } }, "sha512-RITGBfijLkBddZvnn8jdqoTypxvqbOLYQkGGxXzeFjVHvudaPw0HNFD9x928/eUwYWd2dPCugVqspGALTZZQKw=="],
 
+    "chalk": ["chalk@5.4.1", "", {}, "sha512-zgVZuo2WcZgfUEmsn6eO3kINexW8RAE4maiQ8QNs8CtpPCSyMiYsULR3HQYkm3w8FIA3SberyMJMSldGsW+U3w=="],
+
     "check-error": ["check-error@1.0.3", "", { "dependencies": { "get-func-name": "^2.0.2" } }, "sha512-iKEoDYaRmd1mxM90a2OEfWhjsjPpYPuQ+lMYsoxB126+t8fw7ySEO48nmDg5COTjxDI65/Y2OWpeEHk3ZOe8zg=="],
 
     "confbox": ["confbox@0.1.8", "", {}, "sha512-RMtmw0iFkeR4YV+fUOSucriAQNb9g8zFR52MWCtl+cCZOFRNL6zeB395vPzFhEjjn4fMxXudmELnl/KF/WrK6w=="],

package/{airport-docker.ts → example/airport-docker.ts}

@@ -1,5 +1,5 @@
-import { name, version } from './package.json'
-import { PipeLine, Task } from './src/airport'
+import { name, version } from '../package.json'
+import { PipeLine, Task } from '../src/airport'
 
 // 创建部署任务
 const deployTask = new Task({

package/{airport.ts → example/airport.ts}

@@ -1,6 +1,6 @@
 import { join } from 'path'
-import { name, version } from './package.json'
-import { PipeLine, Task, remote, exec, logError } from './src/airport'
+import { name, version } from '../package.json'
+import { PipeLine, Task, remote, logError } from '../src/airport'
 
 const file = [name, version].join('-') + '.tgz'
 
@@ -18,10 +18,8 @@ const deployTask = new Task({
     {
       name: '发布到远程服务器',
       async run() {
-        exec(true, 'ls -al .cache')
         const ssh = remote('gavin@192.168.5.121')
         const dir = (path?: string) => join('/home/gavin/test', path ?? '')
-
         try {
           await ssh.run('rm -f', dir('latest'))
           await ssh.run('mkdir -p', dir(version))

package/example/airstep.ts

@@ -0,0 +1,12 @@
+import { Step } from '../src/airport'
+
+// 创建部署任务
+const step = new Step({
+  name: '构建项目',
+  run: [
+    'mkdir -p .cache',
+    'mv `npm pack` .cache/',
+  ],
+})
+
+step.run()

package/example/airtask.ts

@@ -0,0 +1,38 @@
+import { join } from 'path'
+import { name, version } from '../package.json'
+import { Task, remote, logError } from '../src/airport'
+
+const file = [name, version].join('-') + '.tgz'
+
+// 创建部署任务
+const deployTask = new Task({
+  name: '部署应用',
+  steps: [
+    {
+      name: '构建项目',
+      run: [
+        'mkdir -p .cache',
+        'mv `npm pack` .cache/',
+      ],
+    },
+    {
+      name: '发布到远程服务器',
+      async run() {
+        const ssh = remote('gavin@192.168.5.121')
+        const dir = (path?: string) => join('/home/gavin/test', path ?? '')
+        try {
+          await ssh.run('rm -f', dir('latest'))
+          await ssh.run('mkdir -p', dir(version))
+          await ssh.scp(`.cache/${file}`, dir())
+          await ssh.run('tar -zxvf', dir(file), '-C', dir(version))
+          await ssh.run('ln -s', dir(version), dir('latest'))
+        }
+        catch (e) {
+          logError(e)
+        }
+      },
+    },
+  ],
+})
+
+deployTask.run()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "airport2",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "src/index.ts",
   "type": "module",
   "scripts": {
@@ -33,5 +33,8 @@
     "@types/bun": "latest",
     "@types/node": "^20.12.7",
     "vitest": "^1.6.0"
+  },
+  "dependencies": {
+    "chalk": "^5.4.1"
   }
 }

package/src/airport/air/pipeline.ts

@@ -1,5 +1,5 @@
 import { Task } from './task'
-import { log } from '../lib/log'
+import { log, purple, gray } from '../lib'
 
 export class PipeLine {
   public name?: string
@@ -17,12 +17,12 @@ export class PipeLine {
    * 执行任务中的所有步骤
    */
   async run() {
-    log('Start PipeLine: --------------------')
+    log(purple('Pipe'), gray('Start'), '-------------------------')
 
     for (const task of this.tasks) {
-      await task.execute()
+      await task.run()
     }
 
-    log('----------- End PipeLine -----------')
+    log(`------------- ${purple("Pipe")} ${gray('End')} -------------`)
   }
 }

package/src/airport/air/step.ts

@@ -1,21 +1,23 @@
-import { run } from '../lib/run'
+import { log, run } from '../lib'
 import type { StepRaw } from '../types'
 
 export class Step {
   public name: string
-  private test: boolean
+  public skip: boolean = false
   private step: StepRaw
+  private test: boolean
 
   constructor(step: StepRaw, test: boolean = false) {
     this.test = test
     this.step = step
     this.name = step.name
+    this.skip = step.skip ?? false
   }
 
   /**
    * 执行步骤
    */
-  async execute(): Promise<any> {
+  async run(): Promise<any> {
     if (typeof this.step.run === 'string') {
       return this.runString()
     } else if (Array.isArray(this.step.run)) {
@@ -23,7 +25,7 @@ export class Step {
     } else {
       // 函数类型的步骤
       if (this.test) {
-        console.log(`[TEST MODE] Would execute function: ${this.step.run.name}`)
+        log(`[TEST MODE] Would execute function: ${this.step.run.name}`)
       } else {
         // 实际执行函数
         return await this.step.run()
@@ -37,7 +39,7 @@ export class Step {
   private async runString() {
     const runString = this.step.run as string
     if (this.test) {
-      console.log(`[TEST MODE] Would execute: ${runString}`)
+      log(`[TEST MODE] Would execute: ${runString}`)
     } else {
       return await run(runString)
     }
@@ -49,7 +51,7 @@ export class Step {
   private async runArray() {
     const runArray = this.step.run as string[]
     if (this.test) {
-      console.log(`[TEST MODE] Would execute array: ${runArray}`)
+      log(`[TEST MODE] Would execute array: ${runArray}`)
     } else {
       for (const cmd of runArray) {
         await run(cmd)

package/src/airport/air/task.ts

@@ -1,5 +1,5 @@
 import { Step } from './step'
-import { log } from '../lib/log'
+import { log, purple, gray, blue } from '../lib'
 import type { TaskOptions, StepRaw } from '../types'
 
 export class Task {
@@ -16,19 +16,19 @@ export class Task {
   /**
    * 执行任务中的所有步骤
    */
-  async execute(test: boolean = false) {
+  async run(test: boolean = false) {
     const steps = this.steps.map((step) => new Step(step, test))
 
-    log(`Start Task:`, this.name)
+    log(purple('Task'), gray('Start'), blue(this.name))
 
     for (const step of steps) {
-      log(`Start Task.Step:`, step.name)
-
-      await step.execute()
-
-      log(`End Task.Step:`, step.name)
+      if (!step.skip) {
+        log(purple('Step'), gray('Start'), blue(step.name))
+        step.skip || (await step.run())
+        log(purple('Step'), gray('End'), blue(step.name))
+      }
     }
 
-    log(`End Task:`, this.name)
+    log(purple('Task'), gray('End'), blue(this.name))
   }
 }

package/src/airport/index.ts

@@ -1,23 +1,4 @@
+export * from './lib'
 export * from './air/step'
 export * from './air/task'
 export * from './air/pipeline'
-export * from './lib/run'
-export * from './lib/remote'
-export * from './lib/log'
-
-// 导出默认的核心API
-import { PipeLine } from './air/pipeline'
-import { Task } from './air/task'
-import { Step } from './air/step'
-import { run, exec } from './lib/run'
-import { log, logError } from './lib/log'
-import { remote } from './lib/remote'
-
-export default {
-  PipeLine,
-  Task,
-  Step,
-  remote,
-  run, exec,
-  log, logError,
-}

package/src/airport/lib/color.ts

@@ -0,0 +1,10 @@
+import color from 'chalk'
+
+export { color }
+
+export const gray = color.gray
+export const blue = color.hex('#4EC4FF')
+export const green = color.hex('#08cf08')
+export const debug = color.hex('#4CD1E0')
+
+export const purple = color.hex('#cf37f2')

package/src/airport/lib/index.ts

@@ -0,0 +1,5 @@
+export * from './color'
+export * from './date'
+export * from './log'
+export * from './run'
+export * from './remote'

package/src/airport/lib/log.ts

@@ -1,7 +1,8 @@
+import { gray } from './color'
 import { formatTimestamp } from './date'
 
 export const log = (...args: any[]) => {
-  console.log(`[${formatTimestamp()}]`, ...args)
+  console.log(gray(`[${formatTimestamp()}]`), ...args)
 }
 
 export const logError = (...args: any[]) => {

package/src/airport/lib/remote.ts

@@ -21,6 +21,12 @@ class Remote {
     await run(`ssh ${this.opt.ssh} "${cmd.join(' ')}"`)
   }
 
+  /**
+   * scp远程复制文件
+   * @param src 本地路径 e.g. `.cache/app-0.0.1.tgz`
+   * @param dist 远程服务器绝对路径，支持文件夹和文件，e.g. `/tmp/test.txt` or `/tmp`
+   * @returns Promise<void>
+   */
   async scp(src: string, dist: string) {
     await run(`scp ${src} ${this.opt.ssh}:${dist}`)
   }

package/src/airport/lib/run.ts

@@ -1,4 +1,5 @@
 import { log } from './log'
+import { green, gray } from './color'
 import { spawn, execSync } from 'child_process'
 
 /**
@@ -10,10 +11,12 @@ import { spawn, execSync } from 'child_process'
  */
 export const run = (command: string) =>
   new Promise((resolve, reject) => {
-    log('Running:', command)
+    log(gray('Running:'), green(command))
     const child = spawn(command, {
       shell: true,
       stdio: 'inherit',
+      env: process.env,
+      cwd: process.cwd(),
       timeout: 30_000  // 30秒超时
     })
     child.on('exit', resolve)
@@ -37,7 +40,7 @@ export function exec(print: boolean | string, command?: string): string {
   }
   let output = execSync(command ?? 'echo').toString()
   if (print) {
-    log('Running:', command)
+    log(gray('Running:'), green(command))
     log(output)
   }
   return output

package/src/airport/types.ts

@@ -11,6 +11,7 @@ export interface StepResult {
  */
 export interface StepRaw {
   name: string
+  skip?: boolean
   run: string | string[] | ((...args: any[]) => Promise<any>)
 }