airport2 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,12 +1,21 @@
 # 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
 
 * 一些优化

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/{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'
 

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.3",
+  "version": "0.0.4",
   "main": "src/index.ts",
   "type": "module",
   "scripts": {

package/src/airport/air/pipeline.ts

@@ -17,10 +17,10 @@ export class PipeLine {
    * 执行任务中的所有步骤
    */
   async run() {
-    log(purple('Pipe'), gray('Start'), ' -------------------------')
+    log(purple('Pipe'), gray('Start'), '-------------------------')
 
     for (const task of this.tasks) {
-      await task.execute()
+      await task.run()
     }
 
     log(`------------- ${purple("Pipe")} ${gray('End')} -------------`)

package/src/airport/air/step.ts

@@ -17,7 +17,7 @@ export class Step {
   /**
    * 执行步骤
    */
-  async execute(): Promise<any> {
+  async run(): Promise<any> {
     if (typeof this.step.run === 'string') {
       return this.runString()
     } else if (Array.isArray(this.step.run)) {

package/src/airport/air/task.ts

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

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

@@ -15,6 +15,8 @@ export const run = (command: string) =>
     const child = spawn(command, {
       shell: true,
       stdio: 'inherit',
+      env: process.env,
+      cwd: process.cwd(),
       timeout: 30_000  // 30秒超时
     })
     child.on('exit', resolve)