API: Attributable Test Coverage

[connor4312]

For a variety of reasons, it may be useful to know what tests generated what coverage. So let's add some API for that in the form of a second optional parameter for addCoverage.

declare module 'vscode' {
    export class FileCoverage2 extends FileCoverage {
        /**
         * Test {@link TestItem} this file coverage is generated from. If undefined,
         * the editor will assume the coverage is the overall summary coverage for
         * the entire file.
         *
         * If per-test coverage is available, an extension should append multiple
         * `FileCoverage` instances with this property set for each test item. It
         * must also append a `FileCoverage` instance without this property set to
         * represent the overall coverage of the file.
         */
        testItem?: TestItem;

        constructor(
            uri: Uri,
            statementCoverage: TestCoverageCount,
            branchCoverage?: TestCoverageCount,
            declarationCoverage?: TestCoverageCount,
            testItem?: TestItem,
        );
    }
}

[connor4312]

Peek at initial UI: https://github.com/microsoft/vscode/pull/212403

[sanket-bhalerao]

is this feature limited to code for vscode or other projects can utilize this for their test coverage?

[connor4312]

Once the API is finalized, anyone can use it. It is subject to change until then, but we encourage folks to try it out and let us know how it works for them.