Jest 声纳记者

@casualbot/jest-sonar-reporter 是从Christian W. 原始作品衍生出来的 Jest 的自定义结果处理器 这里。 。 。 .

已更新,以便作为记者用于 jest.config以及,提供输出生成的XML文件相对路径的能力.

安装

使用 npm :

npm install --save-dev @casualbot/jest-sonar-reporter

使用线条 :

yarn add --dev @casualbot/jest-sonar-reporter

使用量

在您的拼图中添加以下条目:

{
  "reporters": [ "default", "@casualbot/jest-sonar-reporter" ]
}

然后简单运行:

jest

对于您的持续整合,您只需做:

jest --ci --reporters=default --reporters=@casualbot/jest-sonar-reporter

用作测试

支持 testResultsProcessor 仅出于[遗留原因][测试-结果-处理器]而保留,并可能在将来被删除. 因此,您应该选择配置 @casualbot/jest-sonar-reporter 作为 记者。 。 。 .

如果您还想要, 请在您的游戏配置中添加以下条目 :

{
  "testResultsProcessor": "@casualbot/jest-sonar-reporter"
}

然后简单运行:

jest

对于您的持续整合,您只需做:

jest --ci --testResultsProcessor="@casualbot/jest-sonar-reporter"

配置

@casualbot/jest-sonar-reporter 根据环境变量或环境变量提供几种配置 @casualbot/jest-sonar-reporter 键定义 package.json 或记者选项. 环境变量和软件包。 json 配置应该是 字符串。 。 。 . 记者选项也应该是套件的字符串例外NameTemplate, classetNameTemplate,标题NameTemplate,也可以接受函数返回字符串.

您可以通过以下命令行配置这些选项:

JEST_SUITE_NAME="Jest JUnit Unit Tests" JEST_SONAR_OUTPUT_DIR="./artifacts" jest

或者你也可以定义一个 @casualbot/jest-sonar-reporter 键 package.json全部为 字符串 数值.

{
  ...,
  "jest": {
    "rootDir": ".",
    "testResultsProcessor": "@casualbot/jest-sonar-reporter"
  },
  "@casualbot/jest-sonar-reporter": {
    "suiteName": "jest tests",
    "outputDirectory": "coverage",
    "outputName": "jest-report.xml",
    "uniqueOutputName": "false",
    "classNameTemplate": "{classname}-{title}",
    "titleTemplate": "{classname}-{title}",
    "ancestorSeparator": " › ",
    "usePathForSuiteName": "true",
    "relativePaths": "true"
  }
}

或者可以在记者配置中定义自己的选项.

// jest.config.js
{
    reporters: [
        'default', 
        [ 
            '@casualbot/jest-sonar-reporter',
            {
                relativePaths: true,
                outputName: 'sonar-report.xml',
                outputDirectory: 'coverage'
            }
        ]
    ],
}