Stream Deck for Visual Studio Code 使用教程
1. 项目的目录结构及介绍
Stream Deck for Visual Studio Code 项目的目录结构如下:
decks-vscode/
├── src/
│ ├── main.ts
│ ├── utils.ts
│ └── ...
├── .eslintrc.json
├── .gitignore
├── .prettierrc
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── code.png
├── package-lock.json
├── package.json
├── tsconfig.json
└── ...
目录结构介绍
src/
: 包含项目的主要源代码文件。main.ts
: 项目的入口文件。utils.ts
: 包含一些工具函数。
.eslintrc.json
: ESLint 配置文件。.gitignore
: Git 忽略文件配置。.prettierrc
: Prettier 代码格式化配置。.vscodeignore
: VSCode 忽略文件配置。CHANGELOG.md
: 项目更新日志。LICENSE
: 项目许可证。README.md
: 项目说明文档。code.png
: 项目图标。package-lock.json
: npm 依赖锁定文件。package.json
: 项目依赖和脚本配置。tsconfig.json
: TypeScript 配置文件。
2. 项目的启动文件介绍
项目的启动文件是 src/main.ts
。这个文件是整个插件的入口点,负责初始化插件和注册各种命令。
src/main.ts
文件介绍
import * as vscode from 'vscode';
import { registerCommands } from './commands';
export function activate(context: vscode.ExtensionContext) {
registerCommands(context);
}
export function deactivate() {
// 插件卸载时的清理工作
}
activate
函数:当插件被激活时调用,注册所有命令。deactivate
函数:当插件被卸载时调用,进行清理工作。
3. 项目的配置文件介绍
项目的配置文件主要包括 package.json
和 .vscodeignore
。
package.json
文件介绍
package.json
文件包含了项目的元数据和依赖信息,以及一些脚本命令。
{
"name": "vscode-deck",
"displayName": "Stream Deck for Visual Studio Code",
"version": "5.1.3",
"description": "Enables Stream Deck integration with Visual Studio Code",
"publisher": "nicollasr",
"engines": {
"vscode": "^1.50.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onCommand:vscode-deck.executeCommand"
],
"main": "./src/main.ts",
"contributes": {
"commands": [
{
"command": "vscode-deck.executeCommand",
"title": "Execute Stream Deck Command"
}
]
},
"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": "^8.1.3",
"typescript": "^4.0.3",
"vscode-test": "^1.4.0"
}
}
name
: 插件名称。displayName
: 插件显示名称。- `