bk-press 0.0.1

package/lib/util/file.js

@@ -0,0 +1,151 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = readFile;
+exports.deleteFile = deleteFile;
+exports.writeFile = writeFile;
+exports.writeEditableFile = writeEditableFile;
+exports.createFolder = createFolder;
+exports.deleteFolder = deleteFolder;
+exports.isFileOrFolderExist = isFileOrFolderExist;
+exports.isFolder = isFolder;
+exports.isFile = isFile;
+const fs_1 = __importDefault(require("fs"));
+function readFile(path, isJSONFile = true) {
+    return new Promise((resolve) => {
+        // 异步地读取JSON文件
+        fs_1.default.readFile(path, "utf8", (err, data) => {
+            if (err) {
+                console.error("An error occurred while reading the JSON file:", err);
+                resolve("");
+                return;
+            }
+            if (isJSONFile) {
+                try {
+                    // 解析JSON数据到对象
+                    const jsonObj = JSON.parse(data);
+                    // 现在您可以使用这个对象了
+                    resolve(jsonObj);
+                }
+                catch (parseError) {
+                    console.error("Error parsing JSON:", parseError);
+                    resolve("");
+                }
+            }
+            else {
+                resolve(data);
+            }
+        });
+    });
+}
+function deleteFile(path) {
+    return new Promise((resolve) => {
+        fs_1.default.unlink(path, (err) => {
+            if (err) {
+                console.error("Failed to delete file: ", err);
+                resolve(false);
+                return;
+            }
+            resolve(true);
+        });
+    });
+}
+function writeFile(path, cotent) {
+    return new Promise((resolve) => {
+        fs_1.default.writeFile(path, cotent, "utf8", (fileErr) => {
+            if (fileErr) {
+                console.error("Failed to write file: ", fileErr);
+                resolve(false);
+                return;
+            }
+            resolve(true);
+        });
+    });
+}
+function writeEditableFile(path, cotent) {
+    return new Promise((resolve) => {
+        fs_1.default.writeFile(path, cotent, { mode: 0o666 }, (fileErr) => {
+            if (fileErr) {
+                console.error("Failed to write file: ", fileErr);
+                resolve(false);
+                return;
+            }
+            resolve(true);
+        });
+    });
+}
+function createFolder(path) {
+    return new Promise((resolve, reject) => {
+        fs_1.default.mkdir(path, { recursive: true }, (folderErr) => {
+            if (folderErr) {
+                // vscode.window.showErrorMessage('Failed to create folder');
+                console.error("Failed to create folder: ", folderErr);
+                resolve(false);
+                return;
+            }
+            resolve(true);
+        });
+    });
+}
+function deleteFolder(path) {
+    return new Promise((resolve) => {
+        fs_1.default.rm(path, { recursive: true, force: true }, (err) => {
+            if (err) {
+                console.error(`Failed to delete folder ${path}: `, err);
+                resolve(false);
+                return;
+            }
+            resolve(true);
+        });
+    });
+}
+function isFileOrFolderExist(path) {
+    return new Promise((resolve) => {
+        fs_1.default.access(path, fs_1.default.constants.F_OK, (err) => {
+            if (err) {
+                console.error("file or folder not exist: ", err);
+                // 处理文件或文件夹不存在的逻辑
+                resolve(false);
+            }
+            else {
+                console.log(`${path} exists`);
+                // 处理文件或文件夹存在的逻辑
+                resolve(true);
+            }
+        });
+    });
+}
+function isFolder(path) {
+    return new Promise((resolve) => {
+        fs_1.default.stat(path, (err, stats) => {
+            if (err) {
+                console.error("isFolder err: ", err);
+                resolve(false);
+                return;
+            }
+            if (stats.isDirectory()) {
+                resolve(true);
+                return;
+            }
+            resolve(false);
+        });
+    });
+}
+function isFile(path) {
+    return new Promise((resolve) => {
+        fs_1.default.stat(path, (err, stats) => {
+            if (err) {
+                console.error("isFile err: ", err);
+                resolve(false);
+                return;
+            }
+            if (stats.isFile()) {
+                resolve(true);
+                return;
+            }
+            resolve(false);
+        });
+    });
+}

package/lib/util/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./file"), exports);

package/lib/util/pkg.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installDependencies = installDependencies;
+const child_process_1 = require("child_process");
+const which_pm_runs_1 = __importDefault(require("which-pm-runs"));
+function installDependencies() {
+    return new Promise((resolve, reject) => {
+        console.log("开始安装自动化测试相关依赖...");
+        // 确定使用 npm 还是 yarn（可根据项目检测）
+        const pkgTool = (0, which_pm_runs_1.default)()?.name || "npm";
+        const installPrefix = pkgTool === "npm" ? `${pkgTool} install -D` : `${pkgTool} add -D`;
+        (0, child_process_1.exec)(`${installPrefix} cypress-parallel cypress-multi-reporters start-server-and-test`, {
+            cwd: process.cwd(), // 关键：指定工作目录为项目路径
+        }, (error, stdout, stderr) => {
+            if (error) {
+                console.error("依赖安装失败:", error);
+                reject(error);
+                return;
+            }
+            console.log("依赖安装成功!");
+            console.log(stdout);
+            resolve(stdout);
+        });
+    });
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "bk-press",
+  "version": "0.0.1",
+  "description": "A CLI for cypress automation testing",
+  "main": "lib/index.js",
+  "bin": {
+    "bkpress": "./lib/index.js"
+  },
+  "scripts": {
+    "dev": "ts-node --transpile-only src/index.ts",
+    "build": "tsc",
+    "start": "node lib/index.js"
+  },
+  "keywords": [
+    "bkpress",
+    "bk-press",
+    "自动化测试",
+    "端到端测试",
+    "组件测试",
+    "Cypress"
+  ],
+  "author": "austinqli",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^24.10.0",
+    "@types/which-pm-runs": "^1.0.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "commander": "^14.0.2",
+    "cypress-multi-reporters": "^2.0.5",
+    "cypress-parallel": "^0.15.0",
+    "fs-extra": "^11.3.2",
+    "inquirer": "^12.11.0",
+    "puppeteer": "^24.29.1",
+    "which-pm-runs": "^1.1.0"
+  }
+}

package/src/command/index.ts

@@ -0,0 +1,3 @@
+export * from "./login";
+export * from "./init";
+export * from "./run";

package/src/command/init.ts

@@ -0,0 +1,202 @@
+import { exec } from "child_process";
+import whichPMRuns from "which-pm-runs";
+import path from "path";
+import fs from "fs-extra";
+import {
+  readFile,
+  writeFile,
+  createFolder,
+  deleteFolder,
+  isFileOrFolderExist,
+} from "../util";
+
+export async function init() {
+  console.log("开始初始化Cypress自动化测试...");
+  console.log("安装相关依赖...");
+  await installDependencies();
+  console.log("添加类型到 tsconfig.json 文件...");
+  await addCypressTypesToTsconfigJsonFile();
+  console.log("添加命令到 package.json...");
+  await addScriptsToPackageJson();
+  console.log("创建 cypress 文件夹并拉取模板用例文件...");
+  await addTemplateFiles();
+  console.log("创建 cypress.config.ts 配置文件...");
+  await addCypressConfigFile();
+  console.log("创建 cypress.env.json 配置文件...");
+  await addCypressEnvJsonFile();
+  console.log("添加忽略文件到 .gitignore 文件...");
+  await addIgnoreToGitignoreFile();
+  console.log("Cypress自动化测试初始化完成!");
+}
+
+// 安装自动化测试相关依赖
+function installDependencies() {
+  return new Promise((resolve, reject) => {
+    const pkgTool = whichPMRuns()?.name || "npm";
+
+    const installPrefix =
+      pkgTool === "npm" ? `${pkgTool} install -D` : `${pkgTool} add -D`;
+
+    exec(
+      `${installPrefix} cypress cypress-parallel cypress-multi-reporters start-server-and-test`,
+      {
+        cwd: process.cwd(),
+      },
+      (error, stdout, stderr) => {
+        if (error) {
+          console.error("依赖安装失败:", error);
+          reject(error);
+          return;
+        }
+        console.log("依赖安装成功!");
+        resolve(stdout);
+      }
+    );
+  });
+}
+
+// 添加脚本到 package.json
+async function addScriptsToPackageJson() {
+  const packageJsonFile = path.join(process.cwd(), "package.json");
+  const packageJson = (await readFile(packageJsonFile)) as Record<string, any>;
+  packageJson.scripts["e2e-dev"] = "npx cypress open";
+  packageJson.scripts["e2e"] = "npx cypress run --browser chrome --headless";
+  packageJson.scripts["component-test"] =
+    "npx cypress run --component --browser chrome";
+  await writeFile(packageJsonFile, JSON.stringify(packageJson, null, 2));
+}
+
+// 创建 cypress 文件夹并拉取模板文件
+async function addTemplateFiles() {
+  const isTsProject = await checkIsTsProject();
+  console.log("当前项目是否是 TypeScript 项目: ", isTsProject);
+  await createCypressFolder();
+  await cloneTemplateFiles(isTsProject);
+  await copyTemplateFiles();
+  await deleteGitFolder();
+}
+
+// 创建 cypress 文件夹
+async function createCypressFolder() {
+  const cypressFolder = path.join(process.cwd(), "cypress");
+  await createFolder(cypressFolder);
+}
+
+async function checkIsTsProject() {
+  const tsconfigJsonFile = path.join(process.cwd(), "tsconfig.json");
+  const isTsProject = await isFileOrFolderExist(tsconfigJsonFile);
+  return isTsProject;
+}
+
+// 克隆模板文件
+function cloneTemplateFiles(isTsProject = true) {
+  const targetDir = path.join(process.cwd(), "cypress");
+  const repoListMap = {
+    ts: "git@github.com:jinquantianxia/cypress-template-ts.git",
+    js: "git@github.com:jinquantianxia/cypress-template-js.git",
+  };
+  const repoUrl = repoListMap[isTsProject ? "ts" : "js"];
+  return new Promise((resolve, reject) => {
+    exec(
+      `git clone ${repoUrl}`,
+      {
+        cwd: targetDir,
+      },
+      (error, stdout, stderr) => {
+        if (error) {
+          console.error("克隆模板文件失败:", error);
+          reject(stderr);
+          return;
+        }
+        resolve(stdout);
+      }
+    );
+  });
+}
+
+// 删除 cypress 文件夹中的 .git 文件夹
+async function deleteGitFolder() {
+  const targetDir = path.join(process.cwd(), "cypress", ".git");
+  await deleteFolder(targetDir);
+}
+
+// 复制模板文件到 cypress 文件夹
+async function copyTemplateFiles() {
+  const sourceDir = path.join(process.cwd(), "cypress", "cypress-template-ts");
+  const targetDir = path.join(process.cwd(), "cypress");
+  // 确保目标目录存在
+  await fs.ensureDir(targetDir);
+  // 复制源目录下所有内容到目标目录
+  await fs.copy(sourceDir, targetDir);
+  await deleteFolder(sourceDir);
+}
+
+// 添加 cypress.config.ts 文件
+async function addCypressConfigFile() {
+  const cypressConfigFile = path.join(process.cwd(), "cypress.config.ts");
+  const fileContent = `import { defineConfig } from 'cypress';
+
+export default defineConfig({
+  e2e: {}
+});`;
+  await writeFile(cypressConfigFile, fileContent);
+}
+
+// 添加 cypress.env.json 文件
+async function addCypressEnvJsonFile() {
+  const cypressEnvFile = path.join(process.cwd(), "cypress.env.json");
+  const isExist = await isFileOrFolderExist(cypressEnvFile);
+  if (isExist) {
+    console.log("cypress.env.json 文件已存在，跳过创建");
+    return;
+  }
+  const fileContent = `{
+  "DEV_URL": "",
+  "LOCAL_URL": "",
+  "COOKIE_DOMAIN": ""
+}
+`;
+  await writeFile(cypressEnvFile, fileContent);
+  console.log("cypress.env.json 文件创建成功");
+}
+
+// 添加忽略文件到 .gitignore 文件
+async function addIgnoreToGitignoreFile() {
+  const gitignoreFile = path.join(process.cwd(), ".gitignore");
+  const oldFileContent = await readFile(gitignoreFile, false);
+  const fileContent = `${oldFileContent}\n
+cypress/parallel-weights.json
+cypress/screenshots
+runner-results/
+cypress.env.json
+multi-reporter-config.json`;
+  await writeFile(gitignoreFile, fileContent);
+}
+
+// 添加 cypress 类型到 tsconfig.json 文件
+async function addCypressTypesToTsconfigJsonFile() {
+  const tsconfigJsonFile = path.join(process.cwd(), "tsconfig.json");
+  const tsconfigJson = (await readFile(tsconfigJsonFile)) as Record<
+    string,
+    any
+  >;
+  if (tsconfigJson.include) {
+    tsconfigJson.include.push("cypress/**/*");
+  } else {
+    tsconfigJson.include = ["cypress/**/*"];
+  }
+
+  if (tsconfigJson.compilerOptions) {
+    if (tsconfigJson.compilerOptions.types) {
+      tsconfigJson.compilerOptions.types.push("cypress");
+    } else {
+      tsconfigJson.compilerOptions.types = ["cypress"];
+    }
+  } else {
+    tsconfigJson.compilerOptions = {
+      types: ["cypress"],
+    };
+  }
+  const fileContent = JSON.stringify(tsconfigJson, null, 2);
+  await writeFile(tsconfigJsonFile, fileContent);
+}

package/src/command/login.ts

@@ -0,0 +1,133 @@
+import puppeteer, { type Cookie } from "puppeteer";
+import path from "path";
+import { readFile, writeFile, isFileOrFolderExist } from "../util";
+
+export async function login() {
+  const config = await readCypressEnvConfig();
+  if (!config.devUrl) {
+    throw new Error("cypress.env.json 文件中 DEV_URL 配置不存在");
+  }
+  const browser = await puppeteer.launch({
+    headless: false,
+    args: ["--ignore-certificate-errors"],
+  });
+  console.log("浏览器启动成功!");
+  const page = await browser.newPage();
+  console.log(`${config.devUrl}开发环境页面打开成功!`);
+  await page.goto(config.devUrl);
+  console.log("登录后不要手动关闭浏览器，完成后回到终端按回车键继续...");
+  await waitForEnter(); // 等待用户在终端输入回车
+
+  // 4. 登录成功后，获取当前页面的所有 Cookie
+  const cookies = await page.cookies();
+  await writeCookiesToCypressEnvFile(cookies, config.domainMap);
+  await writeCookiesToCypressCommandFiles(cookies, config.domainMap);
+
+  // 5. 将 Cookie 写入本地文件（例如 cookies.json）
+  // fs.writeFileSync("cookies.json", JSON.stringify(cookies, null, 2));
+  console.log("登录成功，Cookie 已保存至 cypress 命令文件");
+
+  await browser.close(); // 关闭浏览器
+}
+
+export async function readCypressEnvConfig() {
+  const cypressEnvFile = path.join(process.cwd(), "cypress.env.json");
+  const isExist = await isFileOrFolderExist(cypressEnvFile);
+  if (!isExist) {
+    throw new Error("cypress.env.json 文件不存在");
+  }
+  const envJson = (await readFile(cypressEnvFile)) as Record<string, string>;
+  const domainMap: Record<string, string> = {};
+  Object.entries(envJson).forEach(([key, value]) => {
+    if (value.includes(".com")) {
+      domainMap[value] = key;
+    }
+  });
+  return {
+    devUrl: envJson.DEV_URL || "",
+    localUrl: envJson.LOCAL_URL || "",
+    domainMap,
+  };
+}
+
+async function writeCookiesToCypressEnvFile(
+  cookies: Cookie[],
+  domainMap: Record<string, string>
+) {
+  const cypressEnvFile = path.join(process.cwd(), "cypress.env.json");
+  const isExist = await isFileOrFolderExist(cypressEnvFile);
+  if (!isExist) {
+    throw new Error("cypress.env.json 文件不存在");
+  }
+  const envJson = (await readFile(cypressEnvFile)) as Record<string, string>;
+  cookies.forEach((cookie) => {
+    envJson[cookie.name] = cookie.value;
+  });
+  Object.entries(domainMap).forEach(([key, value]) => {
+    envJson[value] = key;
+  });
+  await writeFile(cypressEnvFile, JSON.stringify(envJson, null, 2));
+  console.log("cypress.env.json 文件更新成功");
+}
+
+async function writeCookiesToCypressCommandFiles(
+  cookies: Cookie[],
+  domainMap: Record<string, string>
+) {
+  const cypressCommandFile = path.join(
+    process.cwd(),
+    "cypress",
+    "support",
+    "login.ts"
+  );
+  const isLoginFileExist = await isFileOrFolderExist(cypressCommandFile);
+  if (!isLoginFileExist) {
+    const fileContent = `
+Cypress.Commands.add('login' as any, () => {
+  // 缓存登录会话
+  cy.session('login', () => {
+    ${cookies
+      .map(
+        (cookie) =>
+          `cy.setCookie('${cookie.name}', Cypress.env('${
+            cookie.name
+          }'), { path: '${cookie.path}', domain: Cypress.env('${
+            domainMap[cookie.domain]
+          }') });`
+      )
+      .join("\n    ")}
+  });
+});`;
+    await writeFile(cypressCommandFile, fileContent);
+    console.log("cypress/support/login.ts 文件创建成功");
+  }
+  console.log("cypress/support/login.ts 文件已存在，跳过创建");
+  const cypressE2eFile = path.join(
+    process.cwd(),
+    "cypress",
+    "support",
+    "e2e.ts"
+  );
+  const e2eFileContent = (await readFile(cypressE2eFile, false)) as string;
+  if (e2eFileContent.includes("./login")) {
+    console.log("cypress/support/e2e.ts 文件已存在 ./login 导入，跳过更新");
+    return;
+  }
+  const newE2eFileContent = e2eFileContent + "\nimport './login';";
+  await writeFile(cypressE2eFile, newE2eFileContent);
+  console.log("cypress/support/e2e.ts 文件导入 login.ts 更新成功");
+}
+
+// 一个简单的等待用户输入回车键的函数
+function waitForEnter() {
+  return new Promise((resolve) => {
+    const stdin = process.stdin;
+    stdin.setRawMode(true);
+    stdin.resume();
+    stdin.once("data", () => {
+      stdin.setRawMode(false);
+      stdin.pause();
+      resolve(true);
+    });
+  });
+}

package/src/command/run.ts

@@ -0,0 +1,27 @@
+import { exec } from "child_process";
+import { readCypressEnvConfig } from "./login";
+import os from "os";
+
+export async function run() {
+  console.log("开始运行自动化测试...");
+  const config = await readCypressEnvConfig();
+  const cpuCount = os.cpus().length;
+  console.log("当前CPU核心数: ", cpuCount, ", 设置测试并发数: ", cpuCount);
+  return new Promise((resolve, reject) => {
+    exec(
+      `start-server-and-test dev ${config.localUrl} 'cypress-parallel -s e2e -t ${cpuCount} -d cypress/e2e'`,
+      {
+        cwd: process.cwd(),
+      },
+      (error, stdout, stderr) => {
+        if (error) {
+          console.error("运行自动化测试失败:", error);
+          reject(stderr);
+          return;
+        }
+        console.log("自动化测试运行成功!");
+        resolve(stdout);
+      }
+    );
+  });
+}

package/src/config.ts

@@ -0,0 +1,87 @@
+// src/config.ts
+import { readFileSync, existsSync } from "fs";
+import { join, resolve } from "path";
+import { homedir } from "os";
+
+// 定义配置对象的类型接口，确保类型安全
+export interface CliConfig {
+  project_url?: string;
+}
+
+// 配置读取器函数
+export function loadConfig(): CliConfig | null {
+  // 定义可能的配置文件名
+  const fileName = "bkpress.json";
+
+  let configPath: string | null = null;
+  let configContent: string | null = null;
+
+  // 1. 在项目目录中查找配置文件
+  const potentialPath = join(process.cwd(), fileName);
+  if (existsSync(potentialPath)) {
+    configPath = potentialPath;
+  }
+
+  // 也支持检查用户主目录下的全局配置（可选）
+  // const globalConfigPath = join(homedir(), '.my-cli.config.json');
+  // if (!configPath && existsSync(globalConfigPath)) {
+  //   configPath = globalConfigPath;
+  // }
+
+  if (!configPath) {
+    console.log("未找到脚手架配置文件，将使用默认配置或命令行参数。");
+    return null;
+  }
+
+  try {
+    // 2. 读取文件内容
+    configContent = readFileSync(configPath, "utf-8");
+
+    // 3. 根据文件扩展名解析内容
+    if (configPath.endsWith(".json") || configPath.endsWith(".my-clirc")) {
+      // 解析 JSON，可去除注释（需自行处理或使用支持注释的JSON解析器）
+      return JSON.parse(configContent) as CliConfig;
+    } else if (configPath.endsWith(".ts")) {
+      // 对于 TS 文件，可能需要动态导入（需额外处理，复杂度较高，通常更推荐 JSON 或静态配置）
+      console.warn(
+        "TypeScript 配置文件支持可能需要额外编译步骤，建议使用 JSON 格式。"
+      );
+      // 示例性实现，实际中需谨慎处理
+      // 可能需要先使用 ts-node 或将其编译成 JS 再 require
+      // const tsConfig = require(configPath);
+      // return tsConfig;
+    }
+  } catch (error) {
+    console.error(`读取或解析配置文件失败 (${configPath}):`, error);
+  }
+
+  return null;
+}
+
+// 获取默认配置
+export function getDefaultConfig() {
+  return {
+    local_url: "http://localhost:8080",
+    api_base: "/api",
+    build_output: "dist",
+    features: {
+      typescript: false,
+      lint: false,
+    },
+  };
+}
+
+// 合并配置（用户配置覆盖默认配置）
+export function mergeConfigs(defaultCfg: CliConfig, userCfg: CliConfig | null) {
+  if (!userCfg) return defaultCfg;
+
+  // 简单的深度合并，对于复杂结构可使用 lodash.merge 等库
+  return {
+    ...defaultCfg,
+    ...userCfg,
+    features: {
+      // ...defaultCfg.features,
+      // ...userCfg.features,
+    },
+  };
+}