merge back

.eslintrc.js

@@ -4,7 +4,6 @@ module.exports = {
     "plugin:prettier/recommended",
     "plugin:@typescript-eslint/recommended",
     "plugin:@typescript-eslint/eslint-recommended",
-    "prettier/@typescript-eslint",
   ],
   plugins: ["import"],
   env: {

.github/workflows/PR.yml

@@ -0,0 +1,53 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9.1.4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Get pnpm store directory
+        id: pnpm-store-path
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+      - name: Cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            ${{ steps.pnpm-store-path.outputs.STORE_PATH }}
+            **/node_modules
+          key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-
+      - name: Install Dependencies
+        run: pnpm install
+        shell: bash
+      - name: Lint
+        uses: ./
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"
+          files: "src/**/*"
+      - name: Test
+        run: npm test -- --coverage
+      - name: Build
+        run: npm run build
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.husky/pre-commit

@@ -0,0 +1 @@
+npm exec pretty-quick --staged

.node-version

@@ -0,0 +1 @@
+v22.2.0

.vscode/settings.json

@@ -3,7 +3,7 @@
   "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"],
   "typescript.tsdk": "node_modules/typescript/lib",
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
+    "source.fixAll.eslint": "explicit"
   },
   "cSpell.words": ["octocat", "octokit", "repos"]
 }

__tests__/processResults.test.ts

@@ -1,5 +1,7 @@
+import { error, warning, startGroup, endGroup } from "@actions/core";
+
 import inputs from "../src/inputs";
-import { CHECK_NAME, processResults } from "../src/processResults";
+import { processResults } from "../src/processResults";
 
 jest.mock("@actions/core", () => ({
   debug: jest.fn(),
@@ -16,71 +18,130 @@ jest.mock("../src/inputs", () => ({
 
 const errorMsg = {
   line: 10,
+  endLine: 10,
+  column: 1,
+  endColumn: 10,
   severity: 2,
   ruleId: "no-var",
   message: "no var allowed",
 };
 
 const warnMsg = {
   line: 5,
+  endLine: 5,
+  column: 1,
+  endColumn: 10,
   severity: 1,
   ruleId: "no-console",
   message: "no console allowed",
 };
 
+const multilineMsg = {
+  line: 5,
+  endLine: 10,
+  column: 1,
+  endColumn: 10,
+  severity: 2,
+  ruleId: "no-multiline",
+  message: "no multiline allowed",
+};
+
 const invalidMsg = {
   line: 1,
   severity: 2,
+  column: 1,
+  endColumn: 10,
   ruleId: undefined,
   message: "bad rule",
 };
 
 const mockResults = [
   {
     filePath: "/foo",
-    messages: [errorMsg, warnMsg, { ...errorMsg, line: 20 }],
+    messages: [errorMsg, warnMsg, { ...errorMsg, line: 20, endLine: 20 }],
   },
   {
     filePath: "/bar",
-    messages: [errorMsg, invalidMsg],
+    messages: [errorMsg, invalidMsg, multilineMsg],
   },
 ];
 
-it("returns check endpoint payload with correct annotations", () => {
+it("returns correct error count and warning count", () => {
   // @ts-expect-error
-  const payload = processResults(mockResults);
-
-  expect(payload).toMatchObject({
-    conclusion: "failure",
-    output: {
-      title: CHECK_NAME,
-      summary: "3 error(s) found",
-      annotations: expect.any(Array),
-    },
-  });
+  const result = processResults(mockResults);
 
-  const annotations = payload.output?.annotations;
-  expect(annotations).toHaveLength(4);
+  expect(result).toMatchObject({
+    errorCount: 4,
+    warningCount: 1,
+  });
 });
 
-it("passes the check if there are no errors", () => {
-  const payload = processResults([
-    {
-      filePath: "/bar",
-      // @ts-expect-error
-      messages: [warnMsg, invalidMsg],
-    },
-  ]);
+it("logs each lint result with file annotations", () => {
+  // @ts-expect-error
+  processResults(mockResults);
+
+  expect(error).toHaveBeenCalledTimes(4);
+  expect(warning).toHaveBeenCalledTimes(1);
+
+  expect(error).toHaveBeenNthCalledWith(1, "[no-var] no var allowed", {
+    file: "/foo",
+    startLine: 10,
+    endLine: 10,
+    startColumn: 1,
+    endColumn: 10,
+  });
+
+  expect(warning).toHaveBeenNthCalledWith(1, "[no-console] no console allowed", {
+    file: "/foo",
+    startLine: 5,
+    endLine: 5,
+    startColumn: 1,
+    endColumn: 10,
+  });
+
+  expect(error).toHaveBeenNthCalledWith(2, "[no-var] no var allowed", {
+    file: "/foo",
+    startLine: 20,
+    endLine: 20,
+    startColumn: 1,
+    endColumn: 10,
+  });
 
-  expect(payload.conclusion).toEqual("success");
+  expect(error).toHaveBeenNthCalledWith(3, "[no-var] no var allowed", {
+    file: "/bar",
+    startLine: 10,
+    endLine: 10,
+    startColumn: 1,
+    endColumn: 10,
+  });
+
+  expect(error).toHaveBeenNthCalledWith(4, "[no-multiline] no multiline allowed", {
+    file: "/bar",
+    startLine: 5,
+    endLine: 10,
+  });
 });
 
 it("does not include warnings if quiet option is true", () => {
   Object.defineProperty(inputs, "quiet", {
     get: () => true,
   });
   // @ts-expect-error
-  const payload = processResults(mockResults);
-  expect(payload.output?.annotations).toHaveLength(3);
-  expect(payload.output?.annotations?.some((a) => a.annotation_level === "warning")).toBe(false);
+  const result = processResults(mockResults);
+  expect(result).toMatchObject({
+    errorCount: 4,
+    warningCount: 0,
+  });
+  expect(warning).not.toHaveBeenCalledWith("[no-console] no console allowed", expect.any(Object));
+});
+
+it("groups log output by file", () => {
+  // @ts-expect-error
+  processResults(mockResults);
+
+  expect(startGroup).toHaveBeenCalledTimes(2);
+  expect(endGroup).toHaveBeenCalledTimes(2);
+
+  expect(startGroup).toHaveBeenNthCalledWith(1, "/foo");
+  expect(startGroup).toHaveBeenNthCalledWith(2, "/bar");
 });

action.yml

@@ -24,7 +24,7 @@ inputs:
     default: "false"
     required: false
 runs:
-  using: "node12"
+  using: "node16"
   main: "lib/index.js"
 branding:
   icon: "check-circle"

jest.config.js

@@ -2,4 +2,5 @@ module.exports = {
   preset: "ts-jest",
   testPathIgnorePatterns: ["/node_modules/", "<rootDir>/__tests__/fixtures"],
   collectCoverageFrom: ["src/**/*.ts"],
+  resetMocks: true,
 };