Vitest VSCode 插件使用教程

Vitest VSCode 插件使用教程

vscodeVS Code extension for Vitest项目地址:https://gitcode.com/gh_mirrors/vsco/vscode

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

Vitest VSCode 插件的目录结构如下：

vscode/
├── .github/
│   └── workflows/
├── .vscode/
│   └── extensions.json
├── assets/
│   └── logo.png
├── src/
│   ├── commands/
│   ├── test/
│   ├── extension.ts
│   └── testRunner.ts
├── .gitignore
├── .prettierrc
├── package.json
├── README.md
└── tsconfig.json

目录结构介绍

• .github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .vscode/: 存放 VSCode 的配置文件，例如推荐的扩展。
• assets/: 存放项目相关的静态资源，如图片。
• src/: 存放项目的源代码。
  • commands/: 存放命令相关的代码。
  • test/: 存放测试相关的代码。
  • extension.ts: 插件的主入口文件。
  • testRunner.ts: 测试运行器的入口文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .prettierrc: Prettier 代码格式化配置文件。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。
• tsconfig.json: TypeScript 的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件是插件的入口点，负责注册命令和初始化插件。

src/extension.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 文件介绍

package.json 文件包含了插件的元数据和依赖信息。

{
  "name": "vitest-vscode",
  "displayName": "Vitest",
  "version": "0.1.0",
  "publisher": "vitest",
  "engines": {
    "vscode": "^1.50.0"
  },
  "categories": [
    "Testing"
  ],
  "activationEvents": [
    "onCommand:vitest.runTests"
  ],
  "main": "./out/extension.js",
  "contributes": {
    "commands": [
      {
        "command": "vitest.runTests",
        "title": "Run Vitest Tests"
      }
    ]
  },
  "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: 插件的显示名称。
• version: 插件的版本号。
• publisher: 插件的发布者。
• engines: 插件支持的 VSCode 版本。
• **categories

vscodeVS Code extension for Vitest项目地址:https://gitcode.com/gh_mirrors/vsco/vscode