Merge pull request #5 from xt0rted/template-update

Update action code with setup from xt0rted/problem-matcher

Author: xt0rted

.editorconfig

@@ -7,17 +7,13 @@ indent_size = 4
 indent_style = space
 trim_trailing_whitespace = true
 
-[*.js]
+[*.{js,ts}]
 end_of_line = lf
 indent_size = 2
 
 [*.json]
 indent_size = 2
 
-[*.ts]
-end_of_line = lf
-indent_size = 2
-
 [*.yml]
 indent_size = 2
 

.github/dotnet-format-problem-matcher.json renamed to .github/problem-matcher.json

@@ -1,6 +1,5 @@
 __tests__/runner/*
 
-# comment out in distribution branches
 dist/
 
 node_modules/

.gitignore

@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "dependabot",
+        "promisify"
+    ]
+}

.vscode/settings.json

@@ -1,10 +1,14 @@
 import { matchResults } from "../__helpers__/utils";
-import { problemMatcher as problemMatcherJson } from "../.github/dotnet-format-problem-matcher.json";
+import { problemMatcher as problemMatcherJson } from "../.github/problem-matcher.json";
 import { ProblemMatcher, ProblemPattern } from "github-actions-problem-matcher-typings";
 
-const problemMatcher = problemMatcherJson[0] as ProblemMatcher;
+const problemMatcher: ProblemMatcher = problemMatcherJson[0];
 
 describe("problemMatcher", () => {
+  it("has the correct owner", () => {
+    expect(problemMatcher.owner).toEqual("dotnet-format");
+  });
+
   it("has one pattern", () => {
     expect(problemMatcher.pattern.length).toEqual(1);
   });
@@ -19,24 +23,21 @@ describe("problemMatcher", () => {
     ];
 
     let pattern: ProblemPattern;
-    let regexp: RegExp;
+    let results: RegExpExecArray[];
 
     beforeEach(() => {
       pattern = problemMatcher.pattern[0];
-      regexp = new RegExp(pattern.regexp);
+
+      const regexp = new RegExp(pattern.regexp);
+
+      results = matchResults(reportOutput, regexp);
     });
 
     it("matches violations", () => {
-      const results = matchResults(reportOutput, regexp);
-
       expect(results.length).toEqual(2);
     });
 
     it("matches violation details", () => {
-      const results = matchResults(reportOutput, regexp);
-
-      expect(results.length).toEqual(2);
-
       expect(results[0][pattern.file]).toEqual("src\\ConsoleApp\\Program.cs");
       expect(results[0][pattern.line]).toEqual("5");
       expect(results[0][pattern.column]).toEqual("18");

__tests__/problemMatcher.test.ts

@@ -16,7 +16,10 @@
     "url": "git+https://github.com/xt0rted/dotnet-format-problem-matcher.git"
   },
   "keywords": [
-    "actions"
+    "actions",
+    "github",
+    "problem-matcher",
+    "annotations"
   ],
   "author": "xt0rted",
   "license": "MIT",

package.json

@@ -1,26 +1,37 @@
+import { readFile } from "fs";
 import { join } from "path";
+import { promisify } from "util";
 
 import { getInput, setFailed } from "@actions/core";
 import { issueCommand } from "@actions/core/lib/command"
 
-export function run() {
+import { ProblemMatcher } from "github-actions-problem-matcher-typings";
+
+const readFileAsync = promisify(readFile);
+
+export async function run(): Promise<void> {
   try {
     const action = getInput("action");
 
+    const matcherFile = join(__dirname, "..", ".github", "problem-matcher.json");
+
     switch (action) {
       case "add":
         issueCommand(
           "add-matcher",
           {},
-          join(__dirname, "..", ".github", "dotnet-format-problem-matcher.json"),
+          matcherFile,
         );
         break;
 
       case "remove":
+        const fileContents = await readFileAsync(matcherFile, { encoding: "utf8" });
+        const problemMatcher: ProblemMatcher = JSON.parse(fileContents);
+
         issueCommand(
           "remove-matcher",
           {
-            owner: "dotnet-format",
+            owner: problemMatcher.owner,
           },
           "",
         );