Gitmoji for VSCode 使用教程

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

Gitmoji for VSCode 是一个用于在 Git 提交信息中添加表情符号的扩展。以下是其基本的目录结构：

gitmoji-vscode/
├── .github/
│   └── workflows/
│       └── ci.yml
├── assets/
│   └── icon.png
├── src/
│   ├── extension.ts
│   └── test/
│       └── extension.test.ts
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• .github/workflows/ci.yml: GitHub Actions 的工作流配置文件，用于持续集成。
• assets/icon.png: 扩展的图标文件。
• src/: 源代码目录，包含扩展的主要逻辑和测试代码。
  • extension.ts: 扩展的主文件，包含激活和停用扩展的逻辑。
  • test/extension.test.ts: 扩展的测试文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .vscodeignore: 指定在打包扩展时忽略的文件和目录。
• CHANGELOG.md: 记录版本变更的日志文件。
• LICENSE: 项目的许可证文件。
• package.json: 项目的配置文件，包含依赖、脚本和扩展的元数据。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

Gitmoji for VSCode 的启动文件是 src/extension.ts。这个文件包含了扩展的激活和停用逻辑。

启动文件内容

import * as vscode from 'vscode';

export function activate(context: vscode.ExtensionContext) {
    console.log('Congratulations, your extension "gitmoji-vscode" is now active!');

    let disposable = vscode.commands.registerCommand('extension.gitmoji', () => {
        // 这里是扩展的主要逻辑
    });

    context.subscriptions.push(disposable);
}

export function deactivate() {}

启动文件介绍

• activate 函数: 当扩展被激活时调用，注册命令和事件监听器。
• deactivate 函数: 当扩展被停用时调用，进行清理工作。

3. 项目的配置文件介绍

Gitmoji for VSCode 的主要配置文件是 package.json。这个文件包含了扩展的所有配置信息，包括依赖、脚本、命令和扩展的元数据。

配置文件内容

{
    "name": "gitmoji-vscode",
    "displayName": "Gitmoji",
    "description": "An emoji guide for your commit messages",
    "version": "1.0.0",
    "publisher": "seatonjiang",
    "engines": {
        "vscode": "^1.50.0"
    },
    "categories": [
        "Other"
    ],
    "activationEvents": [
        "onCommand:extension.gitmoji"
    ],
    "main": "./out/extension.js",
    "contributes": {
        "commands": [
            {
                "command": "extension.gitmoji",
                "title": "Gitmoji"
            }
        ]
    },
    "scripts": {
        "vscode:prepublish": "npm run compile",
        "compile": "tsc -p ./",
        "watch": "tsc -watch -p ./",
        "pretest": "npm run compile && npm run lint",
        "lint": "eslint src --ext ts",
        "test": "node ./out/test/runTest.js"
    },
    "devDependencies": {
        "@types/vscode": "^1.50.0",
        "@types/glob": "^7.1.3",
        "@types/mocha": "^8.0.4",
        "@types/node": "^12.11.7",
        "eslint": "^7.10.0",
        "glob": "^7.1.6",
        "mocha