首页
/ Gitmoji for VSCode 使用教程

Gitmoji for VSCode 使用教程

2024-08-17 13:36:43作者:蔡怀权

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
热门项目推荐
相关项目推荐

项目优选

收起
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