Git Commit Plugin 使用教程

1. 项目的目录结构及介绍

git-commit-plugin/
├── .github/
│   └── workflows/
├── assets/
│   └── images/
├── src/
│   ├── extension.ts
│   ├── git.ts
│   ├── message.ts
│   └── utils.ts
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• assets/images: 存放项目相关的图片资源。
• src: 项目的源代码目录，包含主要的TypeScript文件。
  • extension.ts: 插件的主入口文件。
  • git.ts: 处理Git相关操作的文件。
  • message.ts: 处理提交消息的文件。
  • utils.ts: 包含一些通用的工具函数。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• .vscodeignore: 指定在打包插件时忽略的文件和目录。
• CHANGELOG.md: 记录项目的变更日志。
• LICENSE: 项目的开源许可证。
• package.json: 项目的npm配置文件，包含依赖、脚本等信息。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件是插件的入口点，负责初始化插件并注册各种命令。以下是 extension.ts 的主要内容：

import * as vscode from 'vscode';
import { GitExtension } from './git';
import { MessageHandler } from './message';

export function activate(context: vscode.ExtensionContext) {
    const gitExtension = new GitExtension();
    const messageHandler = new MessageHandler();

    let disposable = vscode.commands.registerCommand('extension.gitCommit', () => {
        gitExtension.generateCommitMessage().then(message => {
            messageHandler.showCommitMessage(message);
        });
    });

    context.subscriptions.push(disposable);
}

export function deactivate() {}

• activate: 插件激活时调用的函数，注册命令并初始化相关处理类。
• deactivate: 插件停用时调用的函数。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json。这个文件包含了插件的所有配置信息，包括名称、版本、依赖、命令等。以下是 package.json 的部分内容：

{
  "name": "git-commit-plugin",
  "displayName": "Git Commit Plugin",
  "version": "1.0.0",
  "description": "Automatically generate git commit messages",
  "publisher": "redjue",
  "engines": {
    "vscode": "^1.42.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:extension.gitCommit"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "extension.gitCommit",
        "title": "Generate Git Commit Message"
      }
    ]
  },
  "scripts": {
    "vscode:prepublish": "npm run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install",
    "test": "npm run compile && node ./node_modules/vscode/bin/test"
  },
  "devDependencies": {
    "typescript": "^3.3.1",
    "vscode": "^1.1.28",
    "tslint": "^5.12.1",
    "@types/node": "^10.12.21",
    "@types/mocha": "^2.2.42"
  }
}

• name: 插件的名称。
• displayName: 插件的显示名称。