VSCode Multi-Command 插件使用教程
1. 项目的目录结构及介绍
VSCode Multi-Command 插件的目录结构如下:
vscode-multi-command/
├── .github/
│ └── workflows/
│ └── ci.yml
├── .vscode/
│ └── extensions.json
├── src/
│ ├── extension.ts
│ └── test/
│ └── extension.test.ts
├── package.json
├── README.md
└── CHANGELOG.md
目录结构介绍
- .github/workflows/ci.yml: GitHub Actions 的配置文件,用于持续集成。
- .vscode/extensions.json: VSCode 推荐的扩展列表。
- src/: 插件的主要源代码目录。
- extension.ts: 插件的主入口文件。
- test/: 插件的测试代码目录。
- extension.test.ts: 插件的测试文件。
- package.json: 插件的元数据和依赖管理文件。
- README.md: 插件的说明文档。
- CHANGELOG.md: 插件的更新日志。
2. 项目的启动文件介绍
插件的启动文件是 src/extension.ts
。这个文件定义了插件的主要功能和行为。以下是 src/extension.ts
的主要内容:
import * as vscode from 'vscode';
import { MultiCommand } from './multiCommand';
export function activate(context: vscode.ExtensionContext) {
const multiCommand = new MultiCommand(context);
context.subscriptions.push(multiCommand);
}
export function deactivate() {
// Deactivate logic if needed
}
启动文件介绍
- activate 函数: 当插件被激活时调用,初始化
MultiCommand
实例并将其添加到上下文的订阅列表中。 - deactivate 函数: 当插件被停用时调用,目前没有具体的停用逻辑。
3. 项目的配置文件介绍
插件的配置文件主要是 package.json
。这个文件包含了插件的元数据、依赖、命令和键绑定等信息。以下是 package.json
的部分内容:
{
"name": "multi-command",
"displayName": "Multi Command",
"description": "Invoke multiple commands as one command",
"version": "1.5.0",
"publisher": "ryuta46",
"engines": {
"vscode": "^1.30.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onCommand:extension.multiCommand.execute"
],
"main": "./src/extension.ts",
"contributes": {
"commands": [
{
"command": "extension.multiCommand.execute",
"title": "Multi Command: Execute multi command"
}
],
"keybindings": [
{
"key": "ctrl+shift+alt+k",
"command": "extension.multiCommand.execute",
"args": {
"command": "multiCommand.sample"
}
}
]
},
"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: 插件的显示名称。
- description: 插件的描述。
- version: 插件的版本号。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考