Adding tests

Author: scalvert

.eslintrc.js

@@ -0,0 +1,33 @@
+module.exports = {
+  parser: '@babel/eslint-parser',
+  plugins: ['node', 'jest', 'prettier'],
+  extends: [
+    'eslint:recommended',
+    'plugin:node/recommended',
+    'plugin:jest/recommended',
+    'plugin:jest/style',
+    'plugin:unicorn/recommended',
+    'prettier',
+  ],
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'script',
+    requireConfigFile: false,
+  },
+  env: {
+    browser: false,
+    node: true,
+    es6: true,
+  },
+  rules: {
+    'unicorn/prefer-module': 'off',
+  },
+  overrides: [
+    {
+      files: ['__tests__/**/*.js'],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+};

.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+    time: "04:00"
+  open-pull-requests-limit: 10

.github/workflows/auto-merge.yml

@@ -0,0 +1,14 @@
+name: auto-merge
+
+on:
+  pull_request:
+
+jobs:
+  auto-merge:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ahmadnassri/action-dependabot-auto-merge@v2
+        with:
+          target: minor
+          github-token: ${{ secrets.AUTO_MERGE }}

.github/workflows/ci-build.yml

@@ -0,0 +1,32 @@
+name: CI Build
+
+on:
+  push:
+    branches:
+      - master
+      - 'v*'
+  pull_request: {}
+  schedule:
+    - cron: '0 3 * * *' # daily, at 3am
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ${{matrix.os}}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        node: ['12']
+
+    steps:
+      - uses: actions/checkout@v1
+      - uses: volta-cli/action@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: install dependencies
+        run: yarn install
+      - name: lint
+        run: yarn lint
+      - name: test
+        run: yarn test:jest

.npmignore

@@ -0,0 +1 @@
+__tests__

README.md

@@ -0,0 +1,26 @@
+# @scalvert/ember-template-lint-formatter-sonarqube
+
+![CI Build](https://github.com/scalvert/ember-template-lint-formatter-sonarqube/workflows/CI%20Build/badge.svg)
+[![npm version](https://badge.fury.io/js/%40lint-todo%2Fember-template-lint-formatter-todo.svg)](https://badge.fury.io/js/%40lint-todo%2Fember-template-lint-formatter-todo)
+[![License](https://img.shields.io/npm/l/@scalvert/ember-template-lint-formatter-sonarqube.svg)](https://github.com/@scalvert/ember-template-lint-formatter-sonarqube/blob/master/package.json)
+![Dependabot](https://badgen.net/badge/icon/dependabot?icon=dependabot&label)
+![Volta Managed](https://img.shields.io/static/v1?label=volta&message=managed&color=yellow&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABmJLR0QAeQC6AMEpK7AhAAAACXBIWXMAAAsSAAALEgHS3X78AAAAB3RJTUUH5AMGFS07qAYEaAAAABl0RVh0Q29tbWVudABDcmVhdGVkIHdpdGggR0lNUFeBDhcAAAFmSURBVDjLY2CgB/g/j0H5/2wGW2xyTAQ1r2DQYOBgm8nwh+EY6TYvZtD7f9rn5e81fAGka17GYPL/esObP+dyj5Cs+edqZsv/V8o//H+z7P+XHarW+NSyoAv8WsFszyKTtoVBM5Tn7/Xys+zf7v76vYrJlPEvAwPjH0YGxp//3jGl/L8LU8+IrPnPUkY3ZomoDQwOpZwMv14zMHy8yMDwh4mB4Q8jA8OTgwz/L299wMDyx4Mp9f9NDAP+bWVwY3jGsJpB3JaDQVCEgYHlLwPDfwYWRqVQJgZmHoZ/+3PPfWP+68Mb/Pw5sqUoLni9ipuRnekrAwMjA8Ofb6K8/PKBF5nU7RX+Hize8Y2DOZTP7+kXogPy1zrH+f/vT/j/Z5nUvGcr5VhJioUf88UC/59L+/97gUgDyVH4YzqXxL8dOs/+zuFLJivd/53HseLPPHZPsjT/nsHi93cqozHZue7rLDYhUvUAADjCgneouzo/AAAAAElFTkSuQmCC&link=https://volta.sh)
+[![Code Style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](#badge)
+
+> A custom formatter for `ember-template-lint` that will format the output in SonarQube's [generic issue format](https://docs.sonarqube.org/latest/analysis/generic-issue/).
+
+## Install
+
+```shell
+npm i @scalvert/ember-template-lint-formatter-sonarqube --save-dev
+
+# or
+
+yarn add @scalvert/ember-template-lint-formatter-sonarqube --dev
+```
+
+## Usage
+
+```shell
+ember-template-lint . --format @scalvert/ember-template-lint-formatter-sonarqube
+```

__tests__/index-test.js

@@ -0,0 +1,37 @@
+const stripAnsi = require("strip-ansi");
+const SonarQubeFormatter = require("../index");
+
+class MockConsole {
+  buffer = [];
+
+  get lines() {
+    return this.buffer.map((message) => {
+      return stripAnsi(message).trim();
+    });
+  }
+
+  log(message) {
+    this.buffer.push(message);
+  }
+
+  toString() {
+    return stripAnsi(this.buffer.join("\n"));
+  }
+}
+
+describe("SonarQube Formatter", () => {
+  it("can format output from no results", () => {
+    let mockConsole = new MockConsole();
+    let formatter = new SonarQubeFormatter({
+      console: mockConsole,
+    });
+
+    formatter.print([]);
+
+    expect(mockConsole.toString()).toMatchInlineSnapshot(`
+      "{
+        \\"issues\\": []
+      }"
+    `);
+  });
+});

index.js

@@ -0,0 +1,52 @@
+const path = require('path');
+
+const SONARQUBE_SEVERITY = {
+  '-1': 'INFO', // todo
+  1: 'MINOR', // warning
+  2: 'CRITICAL', // error
+};
+
+const SONARQUBE_TYPE = {
+  '-1': 'CODE_SMELL', // todo
+  1: 'CODE_SMELL', // warning
+  2: 'BUG', // error
+};
+
+module.exports = class SonarQubeFormatter {
+  constructor(options = {}) {
+    this.options = options;
+    this.console = options.console || console;
+  }
+
+  print(results) {
+    const issues = [];
+    for (const result of results) {
+      let relativePath = path.relative(
+        this.options.workingDir,
+        result.filePath
+      );
+
+      for (const message of result.messages) {
+        issues.push({
+          engineId: 'ember-template-lint',
+          ruleId: message.rule,
+          severity: SONARQUBE_SEVERITY[message.severity],
+          type: SONARQUBE_TYPE[message.severity],
+          primaryLocation: {
+            message: message.message,
+            filePath: relativePath,
+            textRange: {
+              startLine: message.line,
+              startColumn: message.column,
+              endLine: message.endLine,
+              endColumn: message.endColumn,
+            },
+          },
+        });
+      }
+    }
+
+    // eslint-disable-next-line unicorn/no-null
+    this.console.log(JSON.stringify({ issues }, null, 2));
+  }
+};

index.ts

@@ -0,0 +1,7 @@
+module.exports = {
+  snapshotFormat: {
+    printBasicPrototype: false,
+  },
+  testEnvironment: 'node',
+  testPathIgnorePatterns: ['/__fixtures__/'],
+};