如何使用 vscode 扩展测试生成覆盖率报告

Question

我正在实现 VSCode 扩展。我按照此链接设置了项目。

它生成一个带有 src/test/runTest.ts 文件的入门项目：

import * as path from 'path';

import { runTests } from '@vscode/test-electron';

async function main() {
    try {
        // The folder containing the Extension Manifest package.json
        // Passed to `--extensionDevelopmentPath`
        const extensionDevelopmentPath = path.resolve(__dirname, '../../');

        // The path to test runner
        // Passed to --extensionTestsPath
        const extensionTestsPath = path.resolve(__dirname, './suite/index');

        // Download VS Code, unzip it and run the integration test
        await runTests({ extensionDevelopmentPath, extensionTestsPath });
    } catch (err) {
        console.error('Failed to run tests');
        process.exit(1);
    }
}

main();

以及 package.json 中的命令：

{
    "compile": "tsc -p ./",
    "pretest": "npm run compile && npm run lint",
    "lint": "eslint src --ext ts",
    "test": "node ./out/test/runTest.js"
}

有没有办法用它生成覆盖率报告？

Answer 1

VSCODE扩展Unitesting使用 mocha> mocha 在引擎盖下。您可以使用许多可用框架之一，例如 c8 ， jest ， istanbul 等。

安装您选择的框架，在这里我使用c8，

npm i --save-dev c8

添加到脚本中

  "scripts": {
    "compile": "tsc -p ./",
    "pretest": "npm run compile && npm run lint",
    "lint": "eslint src --ext ts",
    "test": "node ./out/test/runTest.js",
    "coverage": "c8 --check-coverage npm run test"
  }

并根据您的扩​​展名 检查覆盖范围。在这里，我们正在检查.js文件放置在out/ dir下的文件，我们还排除了负责UniteSting IE OUT/TEST/TEST/的文件（通常）。

.c8rc

{
  "all": true,
  "include": ["out/**"],
  "exclude": ["**/node_modules/**", "out/test/"],
  "reporter": ["html", "text"]
}

运行coverage脚本，您应该获得覆盖范围的输出

npm run coverage

使用上述工作回购： https://github.com/fortran-lang/vscode-fortran-support

Answer 2

如果您使用 vscode-test-cli 现在，它是创建一个默认值通过yo Code的新扩展，这很容易。

安装@vscode/test-cli的依赖项，如果尚未在项目中。

npm install --save-dev @vscode/test-cli

然后，您可以使用以下命令生成覆盖范围。

vscode-test --coverage

注意：您的版本至少应为0.0.6。

您还可以使用- Coverage-Output（默认： os 的温度）和- coverage-reporter（任何可能的Mocha Reporters）。

这意味着，如果您想使用文本和HTML记者在覆盖范围目录中生成覆盖范围，则可以使用以下内容。

vscode-test --coverage --coverage-output ./coverage --coverage-reporter html --coverage-reporter text"

---

@vscode/test-CLI版本0.0.4

1. 安装C8

npm install --save-dev c8

2. 旧解决方案添加覆盖脚本添加到package.json：

"coverage": "c8 npm run test"

3. 通过npm Run Coverage <： /代码>。

就我而言，不需要其他配置。