Merge branch 'master' into releases/v1

xt0rted · xt0rted · commit c686932c0071 · 2020-02-17T21:04:43.000-05:00
diff --git a/.editorconfig b/.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
 
diff --git a/.github/problem-matcher.json b/.github/problem-matcher.json
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,5 @@
 __tests__/runner/*
 
-# comment out in distribution branches
 dist/
 
 node_modules/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "cSpell.words": [
+        "dependabot",
+        "promisify"
+    ]
+}
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
-# dotnet-format Problem Matcher
+# Problem Matcher for dotnet-format
 
 [![CI Workflow Status](https://github.com/xt0rted/dotnet-format-problem-matcher/workflows/CI/badge.svg)](https://github.com/xt0rted/dotnet-format-problem-matcher/actions?query=workflow%3ACI)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=xt0rted/dotnet-format-problem-matcher)](https://dependabot.com)
 
 Adds a problem matcher that will detect errors from [dotnet-format](https://github.com/dotnet/format) and create annotations for them.
 
diff --git a/__data__/dotnetFormatMatcher.ts b/__data__/dotnetFormatMatcher.ts
diff --git a/__tests__/problemMatcher.test.ts b/__tests__/problemMatcher.test.ts
@@ -1,9 +1,16 @@
 import { matchResults } from "../__helpers__/utils";
-import { dotnetFormatMatcher, ProblemMatcherPattern } from "../__data__/dotnetFormatMatcher";
+import { problemMatcher as problemMatcherJson } from "../.github/problem-matcher.json";
+import { ProblemMatcher, ProblemPattern } from "github-actions-problem-matcher-typings";
+
+const problemMatcher: ProblemMatcher = problemMatcherJson[0];
 
 describe("problemMatcher", () => {
+  it("has the correct owner", () => {
+    expect(problemMatcher.owner).toEqual("dotnet-format");
+  });
+
   it("has one pattern", () => {
-    expect(dotnetFormatMatcher.pattern.length).toEqual(1);
+    expect(problemMatcher.pattern.length).toEqual(1);
   });
 
   describe("pattern", () => {
@@ -15,25 +22,22 @@ describe("problemMatcher", () => {
       "  Format complete in 4451ms.",
     ];
 
-    let pattern: ProblemMatcherPattern;
-    let regexp: RegExp;
+    let pattern: ProblemPattern;
+    let results: RegExpExecArray[];
 
     beforeEach(() => {
-      pattern = dotnetFormatMatcher.pattern[0];
-      regexp = new RegExp(pattern.regexp);
+      pattern = problemMatcher.pattern[0];
+
+      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");
diff --git a/action.yml b/action.yml
@@ -1,4 +1,4 @@
-name: "dotnet-format Problem Matcher"
+name: "Problem Matcher for dotnet-format"
 
 description: "Sets up a problem matcher for dotnet-format that's used to create annotations for violations"
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -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",
@@ -25,8 +28,9 @@
   },
   "devDependencies": {
     "@types/jest": "^25.1.2",
-    "@types/node": "^13.7.0",
-    "@zeit/ncc": "^0.21.0",
+    "@types/node": "^13.7.1",
+    "@zeit/ncc": "^0.21.1",
+    "github-actions-problem-matcher-typings": "^1.0.0",
     "jest": "^25.1.0",
     "jest-circus": "^25.1.0",
     "ts-jest": "^25.2.0",
diff --git a/src/main.ts b/src/main.ts
@@ -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,
           },
           "",
         );
diff --git a/tsconfig.json b/tsconfig.json
@@ -62,7 +62,6 @@
   },
   "exclude": [
     "node_modules",
-    "__data__",
     "__helpers__",
     "__tests__"
   ]

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-name: "dotnet-format Problem Matcher"`
	`1`	`+name: "Problem Matcher for dotnet-format"`
`2`	`2`
`3`	`3`	`description: "Sets up a problem matcher for dotnet-format that's used to create annotations for violations"`
`4`	`4`