@taole/deploy-helper 0.0.1

package/README.md

@@ -0,0 +1,2 @@
+# deploy-helper
+脚本部署用

package/index.js

@@ -0,0 +1,225 @@
+#!/usr/bin/env node
+
+import { Client } from 'node-scp'
+import fs from 'fs';
+import { join } from "path";
+import { simpleGit } from 'simple-git';
+import { homedir } from 'os'
+
+/**
+ * 加载配置
+ * @returns 配置对象
+ */
+async function loadConfig() {
+    const configPath = join(process.cwd(), "deploy.config.js");
+    if (fs.existsSync(configPath)) {
+        const config = await import(`file://${configPath}`);
+        return config.default;
+    }
+    const configJsonPath = join(process.cwd(), "deploy.config.json");
+    if (fs.existsSync(configJsonPath)) {
+        const configJson = JSON.parse(fs.readFileSync(configJsonPath, "utf-8"));
+        return configJson;
+    }
+    console.log(`deploy.config.js或deploy.config.json不存在, 请先创建`);
+    return null;
+}
+
+
+async function main() {
+
+    // other commands
+
+    if(process.argv[2] === "help"){
+        console.log(`deploy-helper 部署脚本`);
+        console.log(`usage: deploy-helper [mode]`);
+        console.log(`mode: prod 生产环境部署`);
+        console.log(`mode: test 测试环境部署`);
+        process.exit(0);
+    }
+
+    if(!["prod", "test"].includes(process.argv[2])){
+        console.log("不支持的命令");
+        process.exit(1);
+    }
+    try {
+        const workDir = process.cwd(); // 当前项目根目录
+        const mode = process.argv[2] === 'prod' ? 'prod' : 'test'; // 部署环境
+        console.log(`deploy mode: ${mode}`);
+
+        // 读取配置
+        const config = await loadConfig();
+        // console.log(`config`, config);
+
+        // 检查配置格式
+        if (!config.assets || !config.assets.dest || !config.entry || !config.entry.dest) {
+            console.log(`配置格式错误, 请检查deploy.config.js或deploy.config.json`);
+            return;
+        }
+
+        // 检查项目
+        // 1. 检查项目是否存在
+        const assetsDest = join(workDir, config.assets.dest);
+        const entryDest = join(workDir, config.entry.dest);
+        if (!fs.existsSync(assetsDest)) {
+            console.log(`assets.dest路径不存在: ${assetsDest}, 请先创建`);
+            return;
+        }
+        // test mode下不需要检查entry.dest
+        if (mode === 'prod' && !fs.existsSync(entryDest)) {
+            console.log(`entry.dest路径不存在: ${entryDest}, 请先创建`);
+            return;
+        }
+
+        // 2. 检查项目是否clean
+        const assetsGit = simpleGit(assetsDest);
+        const assetsStatus = await assetsGit.status();
+        if (!assetsStatus.isClean()) {
+            console.log(`${assetsDest}目前有未提交内容, 请先处理`);
+            return;
+        }
+
+        let entryGit;
+        if (mode === 'prod') {
+            entryGit = simpleGit(entryDest);
+            const entryStatus = await entryGit.status();
+            if (!entryStatus.isClean()) {
+                console.log(`${entryDest}目前有未提交内容, 请先处理`);
+                return;
+            }
+        }
+
+        // 2.1如果是prod模式，检查当前项目是不是处于master分支
+        if(mode === 'prod'){
+            const currentGit = simpleGit(workDir);
+            const currentStatus = await currentGit.status();
+            if(!currentStatus.isClean()){
+                console.log(`当前项目有未提交内容, 请先处理`);
+                process.exit(1);
+            }
+            if(currentStatus.branch !== "master"){
+                console.log(`当前项目不是master分支, 请切换至master分支`);
+                process.exit(1);
+            }
+        }
+
+        // 3. 检查项目分支，并切换至master分支
+        if (assetsStatus.current !== "master") {
+            console.log(`${assetsDest}当前分支不是master, 切换至master分支`);
+            await assetsGit.checkout("master");
+            console.log(`${assetsDest}切换至master分支成功`);
+        }
+        if (entryGit && entryStatus.current !== "master") {
+            console.log(`${entryDest}当前分支不是master, 切换至master分支`);
+            await entryGit.checkout("master");
+            console.log(`${entryDest}切换至master分支成功`);
+        }
+
+        // 4. 执行git pull
+        await assetsGit.pull();
+        if (entryGit) {
+            await entryGit.pull();
+        }
+
+        // 5. 复制构建产物
+        // 5.1 复制assets
+        let assetsFilesCount = 0;
+        const assetsFiles = config.assets.files;
+        for (const [src, dest] of Object.entries(assetsFiles)) {
+            const srcPath = join(workDir, src);
+            if (!fs.existsSync(srcPath)) {
+                console.log(`${srcPath}不存在，请确认构建产物是否正确`);
+                return;
+            }
+            const destPath = join(assetsDest, dest);
+            if (fs.statSync(srcPath).isDirectory()) {
+                fs.cpSync(srcPath, destPath, { recursive: true });
+            } else {
+                fs.copyFileSync(srcPath, destPath);
+            }
+            console.log(`assets copy: ${srcPath} -> ${destPath}`);
+            assetsFilesCount++;
+        }
+        console.log(`assets copy done.`);
+        // 5.2 复制entry
+        if (mode === 'prod') {
+            const entryFiles = config.entry.files;
+            for (const [src, dest] of Object.entries(entryFiles)) {
+                const srcPath = join(workDir, src);
+                if (!fs.existsSync(srcPath)) {
+                    console.log(`${srcPath}不存在，请确认构建产物是否正确`);
+                    return;
+                }
+                if (fs.statSync(srcPath).isDirectory()) {
+                    console.log(`entry: ${srcPath}是目录，不支持entry为目录的部署`);
+                    return;
+                }
+                const destPath = join(entryDest, dest);
+                fs.copyFileSync(srcPath, destPath);
+                console.log(`entry copy: ${srcPath} -> ${destPath}`);
+            }
+            console.log(`entry copy done.`);
+        }
+
+        // 6. 提交
+        await assetsGit.add(".");
+        const assetsCommit = `${config.assets.commit || "feat:部署资源文件"} by deploy-helper`;
+        await assetsGit.commit(assetsCommit);
+        console.log(`assets commit: ${assetsCommit}`);
+        if (entryGit) {
+            await entryGit.add(".");
+            const entryCommit = `${config.entry.commit || "feat:部署入口文件"} by deploy-helper`;
+            await entryGit.commit(entryCommit);
+            console.log(`entry commit: ${entryCommit}`);
+        }
+
+        // 7. 推送
+        await assetsGit.push();
+        console.log(`assets push done.`);
+        if(entryGit){
+            await entryGit.push();
+            console.log(`entry push done.`);
+        }
+
+        try {
+            // 8 测试环境将entry scp至测试环境
+            if (mode === 'test' && config.entry.syncTestFiles) {
+                const syncTestFiles = config.entry.syncTestFiles;
+                // 不能放密码。。残念
+                const scpClientConfig = {
+                    host: '192.168.0.35',
+                    username: 'root',
+                    tryKeyboard: true,
+                }
+                const sshKeyPath = join(homedir(), ".ssh/id_rsa");
+                if (fs.existsSync(sshKeyPath)) {
+                    scpClientConfig.privateKey = fs.readFileSync(sshKeyPath, "utf-8");
+                }
+                const scpClient = await Client(scpClientConfig);
+                for (const [src, dest] of Object.entries(syncTestFiles)) {
+                    const srcPath = join(workDir, src);
+                    const destPath = "/home/web/website/tuwan_www/templets/static/play/" + dest;
+                    console.log(`scp: ${srcPath} -> ${destPath}`);
+                    await scpClient.uploadFile(srcPath, destPath)
+                }
+            }
+        } catch (error) {
+            console.log(`scp error: ${error}`);
+            console.log(`复制文件到测试环境服务器失败, 建议配置本机ssh免密登录, 参考地址：https://foochane.cn/article/2019061601.html`);
+            if(assetsFilesCount > 0){
+                console.log(`不过请放心，构建产物的assets已经处理完成，只要手动处理index.html文件即可。`);
+            }
+            process.exit(1);
+        }
+        console.log(`deploy-helper deploy done.`);
+        process.exit(0);
+
+    } catch (error) {
+        console.log(`error occurred in deploy-helper`, error);
+        process.exit(1);
+    }
+}
+
+
+main();
+

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@taole/deploy-helper",
+  "version": "0.0.1",
+  "description": "脚本部署工具，用于将项目部署到测试环境或生产环境",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "bin": {
+    "deploy-helper": "index.js",
+    "dh": "index.js"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "files": ["index.js"],
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "node-scp": "^0.0.25",
+    "simple-git": "^3.28.0"
+  }
+}