@cyber-tools/cyber-git 4.0.0

package/frameworks/build.js

@@ -0,0 +1,16 @@
+const path = require("path");
+const esbuild = require("esbuild");
+const { nodeExternalsPlugin } = require("esbuild-node-externals");
+
+setImmediate(async () => {
+  await esbuild.build({
+    entryPoints: [path.resolve(process.cwd(), "./src/index.ts")],
+    bundle: true,
+    format: "cjs",
+    platform: "node",
+    outdir: path.resolve(process.cwd(), "./dist/"),
+    plugins: [nodeExternalsPlugin({
+      packagePath: path.resolve(process.cwd(), "./package.json")
+    })]
+  });
+});

package/frameworks/development.js

@@ -0,0 +1,20 @@
+const fs = require("fs");
+const path = require("path");
+const esbuild = require("esbuild");
+const { promisify } = require("util");
+const { nodeExternalsPlugin } = require("esbuild-node-externals");
+
+setImmediate(async () => {
+  await promisify(fs.rm)(path.resolve(process.cwd(), "./dist/"), { recursive: true, force: true });
+  await esbuild.build({
+    entryPoints: [path.resolve(process.cwd(), "./src/index.ts")],
+    bundle: true,
+    format: "cjs",
+    platform: "node",
+    outdir: path.resolve(process.cwd(), "./dist/"),
+    plugins: [nodeExternalsPlugin({
+      packagePath: path.resolve(process.cwd(), "./package.json")
+    })]
+  });
+  require("../dist/index.js");
+});

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@cyber-tools/cyber-git",
+  "version": "4.0.0",
+  "description": "规范化git操作的相关的脚本和工具",
+  "main": "./dist/index.js",
+  "scripts": {
+    "dev": "node ./frameworks/development.js",
+    "build": "node ./frameworks/build.js",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": "./dist/index.js",
+  "keywords": [
+    "cli",
+    "node",
+    "cyber",
+    "shicheng.yu"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "cli-spinners": "^2.4.0",
+    "commander": "^6.0.0",
+    "esbuild-register": "^3.6.0",
+    "execa": "^4.0.3",
+    "git-remote-origin-url": "^3.1.0",
+    "inquirer": "^7.3.3",
+    "inversify": "^6.0.2",
+    "jsonfile": "^6.0.1",
+    "moment": "^2.29.1",
+    "open": "^7.3.0",
+    "ora": "^5.1.0",
+    "path-exists": "^4.0.0",
+    "prompt-promise": "^1.0.3",
+    "reflect-metadata": "^0.2.2",
+    "simple-git": "^2.20.1"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "esbuild": "^0.27.4",
+    "esbuild-node-externals": "^1.20.1",
+    "i": "^0.3.7",
+    "npm": "^11.12.1"
+  }
+}

package/src/actions/FastCommitAction.ts

@@ -0,0 +1,51 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { ProjectSelfInspection } from "@/services/ProjectSelfInspection";
+import { CommentPresetServices } from "@/services/CommentPresetServices";
+
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+import { SelectCommentType } from "@/utils/SelectCommentType";
+import { ConfirmAndPushRemote } from "@/services/ConfirmAndPushRemote";
+
+@injectable()
+export class FastCommitAction {
+
+  constructor(
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+    @inject(SelectCommentType) private readonly $SelectCommentType: SelectCommentType,
+    @inject(ConfirmAndPushRemote) private readonly $ConfirmAndPushRemote: ConfirmAndPushRemote,
+    @inject(CommentPresetServices) private readonly $CommentPresetServices: CommentPresetServices,
+    @inject(ProjectSelfInspection) private readonly $ProjectSelfInspection: ProjectSelfInspection,
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager
+  ) { };
+
+  public async execute() {
+    const git = this.$ApplicationConfigManager.getGitInstance();
+    const currentPreset = await this.$CommentPresetServices.getCommitPresets();
+    try {
+      await this.$ProjectSelfInspection.execute();
+      if (!await this.$ProjectJudgment.hasIgnoreFile()) {
+        return this.$CommandLineToast.warn("该项目下不存在.gitignore文件");
+      };
+      await git.add(".");
+      const commitType = await this.$SelectCommentType.execute();
+      const commitMessage = await currentPreset[commitType]();
+      this.$CommandLineToast.start("正在提交");
+      await git.commit(commitMessage);
+      this.$CommandLineToast.succeed("提交成功!");
+      await this.$ConfirmAndPushRemote.execute();
+      process.exit(0);
+    } catch (error) {
+      this.$CommandLineToast.fail("提交失败!");
+      throw error;
+    };
+  };
+
+};
+
+IOCContainer.bind(FastCommitAction).toSelf().inRequestScope();

package/src/actions/LaunchRemoteRepo.ts

@@ -0,0 +1,29 @@
+import open from "open";
+import { injectable, inject } from "inversify";
+import gitRemoteOriginUrl from "git-remote-origin-url";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+
+@injectable()
+export class LaunchRemoteRepo {
+
+  constructor(
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast
+  ) { };
+
+  public async execute() {
+    try {
+      this.$CommandLineToast.start("查询git远程仓库,请稍后... ...");
+      const remoteURL = await gitRemoteOriginUrl();
+      await open(remoteURL);
+      this.$CommandLineToast.succeed("complate!");
+    } catch (error) {
+      this.$CommandLineToast.fail("error!");
+      throw error;
+    }
+  };
+
+};
+
+IOCContainer.bind(LaunchRemoteRepo).toSelf().inRequestScope();

package/src/actions/RunGitScripts.ts

@@ -0,0 +1,46 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { FastCommitAction } from "@/actions/FastCommitAction";
+
+import { UpdateRemoteURL } from "@/services/UpdateRemoteURL";
+import { CreateIgnoreFile } from "@/services/CreateIgnoreFile";
+import { ResetCommitWithIgnore } from "@/services/ResetCommitWithIgnore";
+
+import { SelectScriptType } from "@/utils/SelectScriptType";
+
+@injectable()
+export class RunGitScripts {
+
+  constructor(
+    @inject(SelectScriptType) private readonly $SelectScriptType: SelectScriptType,
+    @inject(UpdateRemoteURL) private readonly $UpdateRemoteURL: UpdateRemoteURL,
+    @inject(FastCommitAction) private readonly $FastCommitAction: FastCommitAction,
+    @inject(CreateIgnoreFile) private readonly $CreateIgnoreFile: CreateIgnoreFile,
+    @inject(ResetCommitWithIgnore) private readonly $ResetCommitWithIgnore: ResetCommitWithIgnore
+  ) { };
+
+  public async execute() {
+    try {
+      const selectActionName = await this.$SelectScriptType.execute();
+      if (selectActionName === "fast_commit") {
+        await this.$FastCommitAction.execute();
+      };
+      if (selectActionName === "generate_gitignore_file") {
+        await this.$CreateIgnoreFile.execute();
+      };
+      if (selectActionName === "reset_with_gitignore_file") {
+        await this.$ResetCommitWithIgnore.execute();
+      };
+      if (selectActionName === "update_remote_repo") {
+        await this.$UpdateRemoteURL.execute();
+      };
+      console.log("未知的操作类型", selectActionName);
+    } catch (error) {
+      throw error;
+    };
+  };
+
+};
+
+IOCContainer.bind(RunGitScripts).toSelf().inRequestScope();

package/src/commons/ApplicationConfigManager.ts

@@ -0,0 +1,60 @@
+import os from "os";
+import path from "path";
+import { merge } from "lodash";
+import simpleGit from "simple-git";
+import pathExists from "path-exists";
+import { readFile } from "jsonfile";
+import { injectable } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+
+import type { SimpleGit } from "simple-git";
+
+@injectable()
+export class ApplicationConfigManager {
+
+  private git: SimpleGit = simpleGit();
+
+  /** 应用层内置的默认配置 **/
+  private defaultConfig: any = {};
+
+  /** 操作系统层的配置 **/
+  private systemConfig: any = {};
+
+  /** $HOME目录下的配置 **/
+  private custmerConfig: any = {};
+
+  /** 声明在操作系统层的配置文件路径 **/
+  get systemConfigPath() {
+    return path.join("/etc/", "/cyber-tools/", "./cyber-git-config.json");
+  };
+
+  /** 声明在$HOME目录下的配置文件路径 **/
+  get custmerConfigPath() {
+    return path.join(os.homedir(), "/.cyber-tools/", "./cyber-git-config.json");
+  };
+
+  /** 初始化并加载配置到运行时 **/
+  public async initialize() {
+    if (await pathExists(this.systemConfigPath)) {
+      this.systemConfig = await readFile(this.systemConfigPath);
+    };
+    if (await pathExists(this.custmerConfigPath)) {
+      this.custmerConfig = await readFile(this.custmerConfigPath);
+    };
+  };
+
+  /** 获取最终组合之后的运行时配置 **/
+  public getRuntimeConfig() {
+    const composeConfig = merge(this.defaultConfig, this.systemConfig, this.custmerConfig);
+    return composeConfig;
+  };
+
+  /** 获取SimpleGit的操作示例 **/
+  public getGitInstance(): SimpleGit {
+    return this.git;
+  };
+
+};
+
+IOCContainer.bind(ApplicationConfigManager).toSelf().inSingletonScope();

package/src/commons/IOCContainer.ts

@@ -0,0 +1,4 @@
+import "reflect-metadata";
+import { Container } from "inversify";
+
+export const IOCContainer = new Container();

package/src/index.ts

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+import { program } from "commander";
+import packageJsonContent from "@@/package.json"
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { FastCommitAction } from "@/actions/FastCommitAction";
+import { LaunchRemoteRepo } from "@/actions/LaunchRemoteRepo";
+import { RunGitScripts } from "@/actions/RunGitScripts";
+
+setImmediate(async () => {
+  await IOCContainer.get(ApplicationConfigManager).initialize();
+  program
+    .usage("cyber-git <command>")
+    .version(packageJsonContent.version);
+
+  program
+    .command("commit")
+    .description("提交文件并生成规范化命令")
+    .action(async () => {
+      await IOCContainer.get(FastCommitAction).execute();
+    });
+
+  program
+    .command("open")
+    .description("在浏览器中打开远程的git仓库")
+    .action(async () => {
+      await IOCContainer.get(LaunchRemoteRepo).execute();
+    });
+
+  program
+    .command("script", { isDefault: true })
+    .description("运行其他脚本")
+    .action(async () => {
+      await IOCContainer.get(RunGitScripts).execute();
+    });
+
+  program.parse(process.argv);
+});
+
+
+
+
+
+

package/src/services/CommentPresetServices.ts

@@ -0,0 +1,54 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { CommentMessageGenerater } from "@/utils/CommentMessageGenerater";
+
+@injectable()
+export class CommentPresetServices {
+
+  constructor(
+    @inject(CommentMessageGenerater) private readonly $CommentMessageGenerater: CommentMessageGenerater
+  ) { };
+
+  public async getCommitPresets() {
+    return {
+      "临时提交": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "temp",
+        title: "临时节点标记"
+      }),
+      "简单描述": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "description",
+        title: "简单描述"
+      }),
+      "重构功能": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "refactor",
+        title: "重构功能"
+      }),
+      "新功能": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "feat",
+        title: "开发新功能"
+      }),
+      "修复bug": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "fix",
+        title: "修复存在问题"
+      }),
+      "文档改变": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "docs",
+        title: "变更文档内容"
+      }),
+      "撤销commit": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "revert",
+        title: "回滚提交"
+      }),
+      "增加测试代码": async () => await this.$CommentMessageGenerater.createNormalMessage({
+        type: "test",
+        title: "新增测试代码"
+      })
+    };
+  };
+
+};
+
+
+IOCContainer.bind(CommentPresetServices).toSelf().inSingletonScope();
+

package/src/services/ConfirmAndPushRemote.ts

@@ -0,0 +1,42 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { PopConfirmUtils } from "@/utils/PopConfirmUtils";
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+
+/**
+ * 确认是否需要推送到远程仓库
+ * **/
+@injectable()
+export class ConfirmAndPushRemote {
+
+  constructor(
+    @inject(PopConfirmUtils) private readonly $PopConfirmUtils: PopConfirmUtils,
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager
+  ) { };
+
+  public async execute() {
+    const git = this.$ApplicationConfigManager.getGitInstance();
+    if (await this.$ProjectJudgment.hasRemote()) {
+      try {
+        if (await this.$PopConfirmUtils.execute("是否推送到远程仓库?")) {
+          this.$CommandLineToast.start("正在推送,请稍后...");
+          await git.push();
+          this.$CommandLineToast.succeed("推送成功!");
+        };
+      } catch (error) {
+        throw error;
+      }
+    } else {
+      this.$CommandLineToast.warn("没有检测到远程仓库!");
+    };
+  };
+
+};
+
+IOCContainer.bind(ConfirmAndPushRemote).toSelf().inRequestScope();

package/src/services/CreateIgnoreFile.ts

@@ -0,0 +1,45 @@
+import fs from "fs";
+import path from "path";
+import { promisify } from "util";
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+
+@injectable()
+export class CreateIgnoreFile {
+
+  /**
+   * .gitignore文件的内容摸板
+   * **/
+  private ignoreFiletemplate = [
+    "/node_modules/",
+    "**/.DS_Store",
+    "package-lock.json"
+  ].join("\n");
+
+  constructor(
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast
+  ) { };
+
+  public async execute() {
+    if (await this.$ProjectJudgment.hasIgnoreFile()) {
+      this.$CommandLineToast.warn("该项目已存在.gitignore文件");
+      return false;
+    };
+    try {
+      this.$CommandLineToast.start("正在写入文件");
+      const writeFilePath = path.join(process.cwd(), ".gitignore");
+      await promisify(fs.writeFile)(writeFilePath, this.ignoreFiletemplate);
+      this.$CommandLineToast.succeed("写入成功!");
+    } catch (error) {
+      this.$CommandLineToast.fail("写入失败!");
+      throw error;
+    }
+  };
+
+};
+
+IOCContainer.bind(CreateIgnoreFile).toSelf().inRequestScope();

package/src/services/FirstCommit.ts

@@ -0,0 +1,48 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { ConfirmAndPushRemote } from "@/services/ConfirmAndPushRemote";
+
+import { CommentMessageGenerater } from "@/utils/CommentMessageGenerater";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+
+@injectable()
+export class FirstCommit {
+
+  constructor(
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager,
+    @inject(CommentMessageGenerater) private readonly $CommentMessageGenerater: CommentMessageGenerater,
+    @inject(ConfirmAndPushRemote) private readonly $ConfirmAndPushRemote: ConfirmAndPushRemote,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+  ) { };
+
+  private async createInitMessage() {
+    try {
+      const comment_title = this.$CommentMessageGenerater.createCommentTitle({ type: "init", title: "项目初始化" });
+      const inputDescription = await this.$CommentMessageGenerater.inputDescriptionText("请输入");
+      return [comment_title, inputDescription || "项目初始化提交"].join("\n");
+    } catch (error) {
+      throw error;
+    };
+  };
+
+  public async execute() {
+    try {
+      const git = this.$ApplicationConfigManager.getGitInstance();
+      await git.init();
+      await git.add(".");
+      const commitMessage = await this.createInitMessage();
+      this.$CommandLineToast.start("正在进行项目初始化提交");
+      await git.commit(commitMessage);
+      this.$CommandLineToast.succeed("项目初始化成功!");
+      await this.$ConfirmAndPushRemote.execute();
+    } catch (error) {
+      throw error;
+    };
+  }
+
+};
+
+IOCContainer.bind(FirstCommit).toSelf().inRequestScope();

package/src/services/ProjectSelfInspection.ts

@@ -0,0 +1,48 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { FirstCommit } from "@/services/FirstCommit";
+
+import { CommandLineToast } from "@/utils/CommandLineToast";
+import { PopConfirmUtils } from "@/utils/PopConfirmUtils";
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+
+/**
+ * 项目自检
+ * **/
+@injectable()
+export class ProjectSelfInspection {
+
+  constructor(
+    @inject(FirstCommit) private readonly $FirstCommit: FirstCommit,
+    @inject(PopConfirmUtils) private readonly $PopConfirmUtils: PopConfirmUtils,
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast
+  ) { };
+
+  public async execute() {
+    /** 先检查项目文件夹中是否包含package.json **/
+    if (!await this.$ProjectJudgment.hasPackageJson()) {
+      this.$CommandLineToast.warn("当前项目文件没有package.json文件");
+      process.exit(0);
+    };
+    /** 判断项目是否已经进行了git init操作 **/
+    if (!await this.$ProjectJudgment.isInit()) {
+      const confirmToInitial = await this.$PopConfirmUtils.execute("检测到该项目没有被git初始化,是否进行初始化");
+      if (!confirmToInitial) {
+        process.exit(0);
+      } else {
+        await this.$FirstCommit.execute();
+        process.exit(0);
+      };
+    };
+    /** 判断当前项目文件是否发生了变动 **/
+    if (!await this.$ProjectJudgment.isChange()) {
+      this.$CommandLineToast.warn("当前项目文件没有变动");
+      process.exit(0);
+    };
+  };
+
+};
+
+IOCContainer.bind(ProjectSelfInspection).toSelf().inRequestScope();

package/src/services/ResetCommitWithIgnore.ts

@@ -0,0 +1,39 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { FastCommitAction } from "@/actions/FastCommitAction";
+import { CommandLineToast } from "@/utils/CommandLineToast";
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+
+@injectable()
+export class ResetCommitWithIgnore {
+
+  constructor(
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager,
+    @inject(FastCommitAction) private readonly $FastCommitAction: FastCommitAction,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment
+  ) { };
+
+  public async execute() {
+    const git = this.$ApplicationConfigManager.getGitInstance();
+    if (await this.$ProjectJudgment.hasIgnoreFile()) {
+      try {
+        this.$CommandLineToast.start("正在解除... ...");
+        await git.rm(["-r", "--cached", "."]);
+        this.$CommandLineToast.succeed("解除成功!");
+        await this.$FastCommitAction.execute();
+      } catch (error) {
+        this.$CommandLineToast.fail("重置失败!");
+        throw error;
+      }
+    } else {
+      this.$CommandLineToast.warn("该项目下不存在.gitignore文件");
+    };
+  };
+
+};
+
+IOCContainer.bind(ResetCommitWithIgnore).toSelf().inRequestScope();

package/src/services/UpdateRemoteURL.ts

@@ -0,0 +1,45 @@
+import { injectable, inject } from "inversify";
+
+import { IOCContainer } from "@/commons/IOCContainer";
+import { ApplicationConfigManager } from "@/commons/ApplicationConfigManager";
+
+import { CommandLineToast } from "@/utils/CommandLineToast";
+import { ProjectJudgment } from "@/utils/ProjectJudgment";
+
+
+@injectable()
+export class UpdateRemoteURL {
+
+  constructor(
+    @inject(ApplicationConfigManager) private readonly $ApplicationConfigManager: ApplicationConfigManager,
+    @inject(CommandLineToast) private readonly $CommandLineToast: CommandLineToast,
+    @inject(ProjectJudgment) private readonly $ProjectJudgment: ProjectJudgment
+  ) { };
+
+  public async execute() {
+    const git = this.$ApplicationConfigManager.getGitInstance();
+    if (await this.$ProjectJudgment.hasRemote()) {
+      try {
+        await git.removeRemote("origin");
+        const repoUrl = await prompt("新的远程仓库url:");
+        await git.addRemote("origin", repoUrl);
+        this.$CommandLineToast.succeed("remote更新成功!");
+        // this.$CommandLineToast.start("正在推送,请稍后... ...");
+        // await git.push("origin", {
+        //   "--all": true,
+        //   "--set-upstream": true
+        // });
+        // await git.push(["-u", "origin", "master"]);
+        // this.$CommandLineToast.succeed("推送成功!");
+      } catch (error) {
+        this.$CommandLineToast.fail("更新失败!");
+        throw error;
+      }
+    } else {
+      this.$CommandLineToast.warn("没有检测到远程仓库!");
+    };
+  };
+
+};
+
+IOCContainer.bind(UpdateRemoteURL).toSelf().inRequestScope();