首页
/ Git Commit Plugin 使用教程

Git Commit Plugin 使用教程

2024-08-26 22:49:46作者:幸俭卉

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: 插件的显示名称。
热门项目推荐
相关项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
576
107
Ffit-framework
面向全场景的 Java 企业级插件化编程框架,支持聚散部署和共享内存,以一切皆可替换为核心理念,旨在为用户提供一种灵活的服务开发范式。
Java
111
13
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
285
74
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
44
29
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
204
50
LangBotLangBot
😎丰富生态、🧩支持扩展、🦄多模态 - 大模型原生即时通信机器人平台 | 适配 QQ / 微信(企业微信、个人微信)/ 飞书 / 钉钉 / Discord / Telegram 等消息平台 | 支持 OpenAI GPT、ChatGPT、DeepSeek、Dify、Claude、Gemini、Ollama、LM Studio、SiliconFlow、Qwen、Moonshot、ChatGLM 等 LLM 的机器人 / Agent | LLM-based instant messaging bots platform, supports Discord, Telegram, WeChat, Lark, DingTalk, QQ, OpenAI ChatGPT, DeepSeek
Python
7
1
RGF_CJRGF_CJ
RGF是Windows系统下的通用渲染框架,其基于Direct3D、Direct2D、DXGI、DirectWrite、WIC、GDI、GDIplus等技术开发。RGF仓颉版(后续简称"RGF")基于RGF(C/C++版)封装优化而来。RGF为开发者提供轻量化、安全、高性能以及高度一致性的2D渲染能力,并且提供对接Direct3D的相关接口,以满足开发者对3D画面渲染的需求。
Cangjie
11
0
omega-aiomega-ai
Omega-AI:基于java打造的深度学习框架,帮助你快速搭建神经网络,实现模型推理与训练,引擎支持自动求导,多线程与GPU运算,GPU支持CUDA,CUDNN。
Java
11
2
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
59
47
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
900
0