VSCode Swift 开发环境项目教程

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

vscode-swift-development-environment/
├── .github/
│   └── workflows/
├── assets/
├── src/
│   ├── commands/
│   ├── configuration/
│   ├── languageServer/
│   ├── models/
│   ├── providers/
│   ├── services/
│   ├── test/
│   ├── types/
│   ├── utils/
│   └── extension.ts
├── .gitignore
├── .vscode/
│   ├── extensions.json
│   ├── launch.json
│   ├── settings.json
│   └── tasks.json
├── CHANGELOG.md
├── LICENSE
├── README.md
├── package.json
├── tsconfig.json
└── yarn.lock

• .github/workflows: 包含GitHub Actions的工作流配置文件。
• assets: 项目资源文件，如图片等。
• src: 源代码目录，包含命令、配置、语言服务器、模型、提供者、服务、测试、类型和工具等模块。
• .gitignore: Git忽略文件配置。
• .vscode: VSCode配置文件，包括扩展推荐、启动配置、设置和任务配置。
• CHANGELOG.md: 项目更新日志。
• LICENSE: 项目许可证（Apache-2.0）。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。
• yarn.lock: Yarn包管理器锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts，这是VSCode扩展的入口点。它负责初始化扩展并注册各种命令和服务。

import * as vscode from 'vscode';
import { registerCommands } from './commands';
import { registerProviders } from './providers';
import { registerServices } from './services';

export function activate(context: vscode.ExtensionContext) {
    registerCommands(context);
    registerProviders(context);
    registerServices(context);
}

export function deactivate() {}

• activate: 扩展激活时调用的函数，注册命令、提供者和服务。
• deactivate: 扩展停用时调用的函数。

3. 项目的配置文件介绍

项目的配置文件主要位于 .vscode 目录和 package.json 文件中。

.vscode 目录

• extensions.json: 推荐扩展配置。
• launch.json: 调试配置。
• settings.json: 工作区设置。
• tasks.json: 任务配置。

package.json

package.json 文件包含了项目的元数据、依赖和脚本配置。

{
  "name": "vscode-swift-development-environment",
  "displayName": "Swift Development Environment",
  "version": "2.0.0",
  "description": "Swift Development Environment for VS Code",
  "publisher": "vknabel",
  "engines": {
    "vscode": "^1.52.0"
  },
  "categories": [
    "Programming Languages"
  ],
  "activationEvents": [
    "onLanguage:swift"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [],
    "configuration": {
      "type": "object",
      "title": "Swift Development Environment",
      "properties": {}
    }
  },
  "scripts": {
    "vscode:prepublish": "yarn run compile",
    "compile": "tsc -p ./",
    "watch": "tsc -watch -p ./",
    "postinstall": "node ./node_modules/vscode/bin/install",
    "test": "yarn run compile && node ./node_modules/vscode/bin/test"
  },
  "devDependencies": {
    "typescript": "^4.1.3",
    "vscode": "^1.1.37"
  }
}

• name: 项目名称。
• displayName: 项目显示名称。
• version: 项目版本。
• description: 项目描述。
• publisher: 发布者。