VSCode Conventional Commits 插件使用教程

VSCode Conventional Commits 插件使用教程

vscode-conventional-commits 💬Conventional Commits for VSCode. 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-conventional-commits

1. 项目目录结构及介绍

vscode-conventional-commits/
├── assets/
│   ├── icon.png
│   ├── menu-icon-dark.svg
│   ├── menu-icon-light.svg
├── dist/
│   └── extension.js
├── src/
│   ├── extension.ts
│   ├── ...
├── .gitignore
├── package.json
├── README.md
├── tsconfig.json
└── webpack.config.js

• assets/: 存放插件的图标文件，包括插件的图标和菜单图标。
• dist/: 存放编译后的插件文件，extension.js 是插件的主要入口文件。
• src/: 存放插件的源代码，extension.ts 是插件的主要逻辑文件。
• .gitignore: Git 忽略文件列表。
• package.json: 项目的配置文件，包含插件的元数据、依赖项、脚本等信息。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 配置文件。
• webpack.config.js: Webpack 配置文件，用于打包插件。

2. 项目的启动文件介绍

dist/extension.js

dist/extension.js 是插件的主要入口文件，由 TypeScript 编译生成。该文件包含了插件的所有逻辑代码，当用户在 VSCode 中激活插件时，VSCode 会加载并执行该文件。

src/extension.ts

src/extension.ts 是插件的源代码文件，包含了插件的主要逻辑。该文件定义了插件的激活和停用事件，以及插件的主要功能实现。

3. 项目的配置文件介绍

package.json

package.json 是项目的配置文件，包含了插件的元数据、依赖项、脚本等信息。以下是一些关键配置项的介绍：

• name: 插件的名称，vscode-conventional-commits。
• displayName: 插件的显示名称，%extension.name%。
• description: 插件的描述，💬Conventional Commits for VSCode。
• icon: 插件的图标路径，assets/icon.png。
• publisher: 插件的发布者，vivaxy。
• version: 插件的版本号，1.26.0。
• engines: 插件支持的 VSCode 版本，^1.44.0。
• categories: 插件的分类，Snippets 和 SCM Providers。
• keywords: 插件的关键词，用于搜索和分类。
• repository: 插件的代码仓库地址，https://github.com/vivaxy/vscode-conventional-commits.git。
• activationEvents: 插件的激活事件，包括命令触发和插件启动时的激活事件。
• main: 插件的入口文件路径，./dist/extension.js。
• contributes: 插件的贡献点配置，包括命令、菜单、配置等。
• scripts: 项目的脚本配置，包括编译、打包、发布等命令。
• devDependencies: 开发依赖项，包括 TypeScript、Webpack、Lint 等工具。
• dependencies: 运行时依赖项，包括 @commitlint/cli、@commitlint/config-conventional 等。

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，定义了 TypeScript 编译器的配置选项，包括编译目标、模块系统、文件包含和排除等。

webpack.config.js

webpack.config.js 是 Webpack 的配置文件，定义了插件的打包配置，包括入口文件、输出路径、模块解析、插件等。

通过以上配置文件，开发者可以了解插件的基本结构和功能，并根据需要进行定制和扩展。

vscode-conventional-commits 💬Conventional Commits for VSCode. 项目地址: https://gitcode.com/gh_mirrors/vs/vscode-conventional-commits