Visual Studio Code 扩展项目教程

Visual Studio Code 扩展项目教程

1. 项目的目录结构及介绍

vscode/
├── .github/
│   └── ISSUE_TEMPLATE/
├── assets/
├── docs/
├── src/
│   ├── commands/
│   ├── components/
│   ├── constants/
│   ├── context/
│   ├── hooks/
│   ├── models/
│   ├── providers/
│   ├── services/
│   ├── theme/
│   ├── utils/
│   └── index.tsx
├── test/
├── .editorconfig
├── .eslintrc.json
├── .gitignore
├── .prettierrc
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── package.json
├── README.md
├── tsconfig.json
└── vsc-extension-quickstart.md

目录结构介绍

• .github/: GitHub 相关配置文件，如 Issue 模板。
• assets/: 项目资源文件，如图片等。
• docs/: 项目文档。
• src/: 源代码目录，包含项目的核心逻辑。
  • commands/: 命令相关文件。
  • components/: React 组件。
  • constants/: 常量定义。
  • context/: React Context。
  • hooks/: 自定义 Hooks。
  • models/: 数据模型。
  • providers/: 提供者组件。
  • services/: 服务层。
  • theme/: 主题配置。
  • utils/: 工具函数。
  • index.tsx: 入口文件。
• test/: 测试文件。
• .editorconfig: 编辑器配置。
• .eslintrc.json: ESLint 配置。
• .gitignore: Git 忽略文件配置。
• .prettierrc: Prettier 配置。
• CHANGELOG.md: 更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证。
• package.json: 项目依赖和脚本。
• README.md: 项目说明。
• tsconfig.json: TypeScript 配置。
• vsc-extension-quickstart.md: VS Code 扩展快速入门指南。

2. 项目的启动文件介绍

项目的启动文件是 src/index.tsx，它是整个扩展的入口点。该文件负责初始化扩展并注册命令。

import * as vscode from 'vscode';
import { activate } from './extension';

export function activate(context: vscode.ExtensionContext) {
  // 注册命令和其他初始化逻辑
}

export function deactivate() {
  // 清理逻辑
}

3. 项目的配置文件介绍

package.json

package.json 是 Node.js 项目的核心配置文件，包含了项目的元数据、依赖和脚本。

{
  "name": "vscode-extension",
  "displayName": "VSCode Extension",
  "version": "1.0.0",
  "description": "A VSCode extension",
  "publisher": "your-publisher-name",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Other"
  ],
  "activationEvents": [
    "onCommand:extension.helloWorld"
  ],
  "main": "./src/index.ts",
  "contributes": {
    "commands": [
      {
        "command": "extension.helloWorld",
        "title": "Hello World"
      }
    ]
  },
  "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