search

eugene-manuilov / jest-runner-groups

A custom runner that allows to tag test files and run groups of tests with Jest.
MIT License
128 stars 14 forks source link

Using `jest-runner-groups` with TSDoc / API Extractor #38

Closed dchambers closed 2 years ago

dchambers commented 2 years ago

In case it helps anyone, I started getting this linting error when I Introduced jest-runner-groups into a project already using TSDoc:

error  tsdoc-undefined-tag: The TSDoc tag "@group" is not defined in this configuration  tsdoc/syntax

which I fixed by creating the following tsdoc.json file (which I placed alongside my tsconfig.json file):

{
    "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
    "extends": ["@microsoft/api-extractor/extends/tsdoc-base.json"],
    "supportForTags": {
        "@group": true
    },
    "tagDefinitions": [
        {
            "tagName": "@group",
            "syntaxKind": "block",
            "allowMultiple": true
        }
    ]
}