@taole/deploy-helper 0.0.4 → 0.2.1

package/index.mjs

@@ -11,36 +11,71 @@ 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不存在, 请先创建`);
+    console.log(`deploy.config.json不存在, 请先创建`);
     return null;
 }
 
+async function initConfigJson() {
+    // check if deploy.config.json exists
+    const configJsonPath = join(process.cwd(), "deploy.config.json");
+    if (fs.existsSync(configJsonPath)) {
+        console.log(`deploy.config.json已存在, 请勿重复创建`);
+        return;
+    }
+
+    const content = `
+{
+    "assets": {
+        "dest": "../Static_2025",
+        "commit": "feat:部署资源文件",
+        "files": {
+            "dist/assets": "CHANGE_ME",
+        }
+    },
+    "entry": {
+        "onlyProd": true,
+        "dest": "../events",
+        "commit": "feat:部署入口文件",
+        "files": {
+            "dist/index.html": "CHANGE_ME"
+        }
+    },
+    "testSync": {
+        "dist/index.html": "events/CHANGE_ME.htm"
+    }
+}`;
+    fs.writeFileSync(configJsonPath, content, { encoding: "utf-8" });
+    console.log(`deploy.config.json创建成功`);
+    process.exit(0);
+}
+
+function hasChangeMe(content) {
+    return content.includes("CHANGE_ME");
+}
 
 async function main() {
 
     // other commands
+    let command = process.argv[2];
+    if (!["init", "prod", "test"].includes(command)) {
+        command = "help";
+    }
 
-    if (process.argv[2] === "help") {
+    if (command === "help") {
         console.log(`deploy-helper 部署脚本`);
-        console.log(`usage: deploy-helper [mode]`);
-        console.log(`mode: prod 生产环境部署`);
-        console.log(`mode: test 测试环境部署`);
+        console.log(`usage: deploy-helper [command]`);
+        console.log(`command: init 初始化配置`);
+        console.log(`command: prod 生产环境部署`);
+        console.log(`command: test 测试环境部署`);
+        process.exit(0);
+    } else if (command === "init") {
+        await initConfigJson();
         process.exit(0);
-    }
-
-    if (!["prod", "test"].includes(process.argv[2])) {
-        console.log("不支持的命令");
-        process.exit(1);
     }
     try {
         const workDir = process.cwd(); // 当前项目根目录
@@ -57,11 +92,18 @@ async function main() {
             return;
         }
 
+        const hasChangeMe = hasChangeMe(JSON.stringify(config));
+        if (hasChangeMe) {
+            console.log(`配置中存在默认值(CHANGE_ME), 请先修改配置`);
+            return;
+        }
+
         // 需要处理entry
         const needHandleEntry = (mode === 'prod' && config.entry.onlyProd) || (mode === 'test' && !config.entry.onlyProd);
         const entryTestBranch = (config.entry && config.entry.testBranch) || "test";
         const entryProdBranch = (config.entry && config.entry.prodBranch) || "master";
         const entryTargetBranch = mode === 'prod' ? entryProdBranch : entryTestBranch;
+        const currentProdBranch = config.prodBranch || "master";
 
         // 检查项目
         // 1. 检查项目是否存在
@@ -96,7 +138,7 @@ async function main() {
             }
         }
 
-        // 2.1如果是prod模式，检查当前项目是不是处于master分支
+        // 2.1如果是prod模式，检查当前项目是不是处于主分支
         if (mode === 'prod') {
             const currentGit = simpleGit(workDir);
             const currentStatus = await currentGit.status();
@@ -104,13 +146,14 @@ async function main() {
                 console.log(`当前项目有未提交内容, 请先处理`);
                 process.exit(1);
             }
-            if (currentStatus.branch !== "master") {
-                console.log(`当前项目不是master分支, 请切换至master分支`);
+            if (currentStatus.branch !== currentProdBranch) {
+                console.log(`当前项目不是${currentProdBranch}分支, 请切换至${currentProdBranch}分支再执行prod命令`);
                 process.exit(1);
             }
         }
 
-        // 3. 检查项目分支，并切换至master分支
+        // 3. 检查assets项目分支，并切换至master分支
+        // assets项目固定使用master分支
         if (assetsStatus.current !== "master") {
             console.log(`${assetsDest}当前分支不是master, 切换至master分支`);
             await assetsGit.checkout("master");
@@ -199,14 +242,12 @@ async function main() {
 
         // 7. 推送
         if (canPushAssets) {
-            const assetsPushResult = await assetsGit.push();
+            await assetsGit.push();
             console.log(`assets push done.`);
-            // console.log(`assets push: ${JSON.stringify([...assetsPushResult.remoteMessages.all()])}`);
         }
         if (canPushEntry) {
-            const entryPushResult = await entryGit.push();
+            await entryGit.push();
             console.log(`entry push done.`);
-            // console.log(`entry push: ${JSON.stringify([...entryPushResult.remoteMessages.all()])}`);
         }
 
         try {

package/package.json

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