Add json-file option

Author: 9999years

action.yml

@@ -12,6 +12,9 @@ inputs:
     description: 'Path or JSON array of paths to check with hlint'
     required: false
     default: '.'
+  json-file:
+    description: 'Existing hlint JSON output file to use instead of running hlint'
+    required: false
 outputs:
   ideas:
     description: 'A JSON array of HLint output ideas (errors, warnings, suggestions, and so on)'

src/inputs.ts

@@ -34,14 +34,16 @@ function parseCheckMode(arg: string): CheckMode {
 const INPUT_KEY_HLINT_BIN = 'hlint-bin';
 const INPUT_KEY_HLINT_FILES = 'path';
 const INPUT_KEY_HLINT_FAIL_MODE = 'fail-on';
+const INPUT_KEY_JSON_FILE = 'json-file';
 
 export default function getInputs(): RunArgs {
   const hlintCmd = core.getInput(INPUT_KEY_HLINT_BIN, {required: false}) || 'hlint';
   const pathList = parseStringOrJsonArray(core.getInput(INPUT_KEY_HLINT_FILES, {required: false}) || '.');
   const failOn = parseCheckMode(core.getInput(INPUT_KEY_HLINT_FAIL_MODE, {required: false}) || 'NEVER');
+  const jsonFile = core.getInput(INPUT_KEY_JSON_FILE, {required: false});
 
   // NOTE: Because ncc compiles all the files, take care that __dirname represents the dist/ folder.
   const baseDir = path.join(__dirname, '..');
 
-  return {baseDir, hlintCmd, pathList, failOn};
+  return {baseDir, hlintCmd, jsonFile, pathList, failOn};
 }

src/run.ts

@@ -1,5 +1,6 @@
 import * as core from '@actions/core'
 import * as path from 'path'
+import * as fs from 'fs'
 import {
   Idea as HLintIdea,
   Severity as HLintSeverity,
@@ -15,6 +16,7 @@ export type CheckMode = HLintSeverity | 'STATUS' | 'NEVER';
 export interface RunArgs {
   baseDir: string,
   hlintCmd: string,
+  jsonFile: string,
   pathList: string[],
   failOn: CheckMode,
 };
@@ -42,6 +44,26 @@ async function runHLint(cmd: string, args: string[]): Promise<HLintResult> {
   return {ideas, statusCode};
 }
 
+async function readHLintFile(path: string): Promise<HLintResult> {
+  const fileContents = await fs.promises.readFile(path, 'utf8');
+  const hints: Array<HLintIdea> = JSON.parse(fileContents) || [];
+  hints.forEach(hint => {
+    const fromTo = hint.to
+      ? [`(Found: ${hint.from})`, `(Perhaps: ${hint.to})`]
+      : [`(Remove: ${hint.from})`];
+    const message = [...fromTo, ...hint.note].join('\n');
+    const properties = {...hint, title: `${hint.severity}: ${hint.hint}`};
+    if (hint.severity == "Error") {
+      core.error(message, properties);
+    } else {
+      core.warning(message, properties);
+    }
+  });
+  const ideas = hints;
+  const statusCode = ideas.length;
+  return {ideas, statusCode};
+}
+
 function getOverallCheckResult(failOn: CheckMode, {ideas, statusCode}: HLintResult): CheckResult {
   const hintsBySev = HLINT_SEV_LEVELS.map(sev => ([sev, ideas.filter(hint => hint.severity === sev).length]));
   const hintSummary = hintsBySev
@@ -66,10 +88,16 @@ function getOverallCheckResult(failOn: CheckMode, {ideas, statusCode}: HLintResu
   return {ok, hintSummary}
 }
 
-export default async function run({baseDir, hlintCmd, pathList, failOn}: RunArgs): Promise<RunResult> {
-  const hlintArgs = ['-j', '--json', '--', ...pathList]
-  const matcherDefPath = path.join(baseDir, MATCHER_DEF_PATH);
-  const {ideas, statusCode} = await withMatcherAtPath(matcherDefPath, () => runHLint(hlintCmd, hlintArgs));
-  const {ok, hintSummary} = getOverallCheckResult(failOn, {ideas, statusCode});
-  return {ok, statusCode, ideas, hintSummary};
+export default async function run({baseDir, hlintCmd, jsonFile, pathList, failOn}: RunArgs): Promise<RunResult> {
+  if (jsonFile) {
+    const {ideas, statusCode} = await readHLintFile(jsonFile);
+    const {ok, hintSummary} = getOverallCheckResult(failOn, {ideas, statusCode});
+    return {ok, statusCode, ideas, hintSummary};
+  } else {
+    const hlintArgs = ['-j', '--json', '--', ...pathList]
+    const matcherDefPath = path.join(baseDir, MATCHER_DEF_PATH);
+    const {ideas, statusCode} = await withMatcherAtPath(matcherDefPath, () => runHLint(hlintCmd, hlintArgs));
+    const {ok, hintSummary} = getOverallCheckResult(failOn, {ideas, statusCode});
+    return {ok, statusCode, ideas, hintSummary};
+  }
 }