Integrate custom_lint (#218)

Author: kuhnroyal

.github/workflows/test.yml

@@ -25,3 +25,4 @@ jobs:
         with:
           working-directory: ./dart
           annotate-only: true
+          fatal-warnings: false

.gitignore

@@ -96,4 +96,7 @@ Thumbs.db
 
 # Ignore built ts files
 __tests__/runner/*
-lib/**/*
+lib/**/*
+
+# Ignore IDEA
+.idea

README.md

@@ -45,6 +45,11 @@ jobs:
           # (defaults to false).
           annotate-only: false
 
+          # (Optional) If set to true the GitHub action will run custom_lint
+          # if it is found as dependency in the pubspec.yaml
+          # (defaults to false).
+          custom-lint: false
+
           # (Optional) The working directory to run the Dart analyzer in 
           # (defaults to `./`).
           working-directory: ./

__tests__/main.test.ts

@@ -4,6 +4,6 @@ import * as path from 'path';
 import { test } from '@jest/globals';
 
 test('TODO', async () => {
-  const result = await dart.analyze(path.resolve(__dirname, '../dart'));
+  const result = await dart.analyze(path.resolve(__dirname, '../dart'), true);
   console.dir(result);
 });

action.yml

@@ -18,6 +18,10 @@ inputs:
     required: false
     description: "If set to true only annotations will be created and the GitHub action itself will not fail on Dart analyzer problems. (defaults to false)."
     default: "false"
+  custom-lint:
+    required: false
+    description: "If set to true the GitHub action will run custom_lint if it is found as dependency in the pubspec.yaml. (defaults to false)."
+    default: "false"
   working-directory:
     required: false
     description: "The working directory to run the Dart analyzer in (defaults to `./`)."

dist/index.js

@@ -1,11 +1,14 @@
 import * as core from '@actions/core';
 import * as exec from '@actions/exec';
+import * as fs from 'fs';
+import * as util from 'util';
 
 export interface AnalyzerOptions {
   fatalInfos: boolean;
   fatalWarnings: boolean;
   annotate: boolean;
   annotateOnly: boolean;
+  customLint: boolean;
   workingDirectory: string;
 }
 
@@ -52,8 +55,11 @@ export interface AnalyzerResult {
   errors: AnalyzerProblem[];
 }
 
-export async function analyze(cwd?: string): Promise<AnalyzerResult> {
-  const execOutput = await exec.getExecOutput(
+export async function analyze(
+  cwd: string,
+  customLint: boolean,
+): Promise<AnalyzerResult> {
+  const analyzeOutput = await exec.getExecOutput(
     'dart',
     ['analyze', '--format=json', '.'],
     {
@@ -62,7 +68,35 @@ export async function analyze(cwd?: string): Promise<AnalyzerResult> {
       ignoreReturnCode: true,
     },
   );
-  return parseAnalyzerResult(execOutput.stdout.trim());
+  const result = parseAnalyzerResult(analyzeOutput.stdout.trim());
+  if (customLint) {
+    const pubspec =
+      cwd == null
+        ? 'pubspec.yaml'
+        : cwd.endsWith('/')
+        ? cwd
+        : `${cwd}/pubspec.yaml`;
+    const readFile = util.promisify(fs.readFile);
+    const contents = await readFile(pubspec, 'utf8');
+    if (contents.includes('custom_lint:')) {
+      const customLintOutput = await exec.getExecOutput(
+        'dart',
+        ['run', 'custom_lint', '--format=json', '.'],
+        {
+          cwd,
+          silent: false,
+          ignoreReturnCode: true,
+        },
+      );
+      const customLintResult = parseAnalyzerResult(
+        customLintOutput.stdout.trim(),
+      );
+      result.infos.push(...customLintResult.infos);
+      result.warnings.push(...customLintResult.warnings);
+      result.errors.push(...customLintResult.errors);
+    }
+  }
+  return result;
 }
 
 export function parseAnalyzerResult(

dist/index.js.map

@@ -49,6 +49,7 @@ async function run(): Promise<void> {
       fatalWarnings: core.getBooleanInput('fatal-warnings'),
       annotate: core.getBooleanInput('annotate'),
       annotateOnly: core.getBooleanInput('annotate-only'),
+      customLint: core.getBooleanInput('custom-lint'),
       workingDirectory: path.resolve(
         process.env['GITHUB_WORKSPACE'] || process.cwd(),
         core.getInput('working-directory'),
@@ -58,7 +59,7 @@ async function run(): Promise<void> {
     core.debug(
       `Running Dart analyzer with options: ${JSON.stringify(options)}`,
     );
-    const result = await analyze(options.workingDirectory);
+    const result = await analyze(options.workingDirectory, options.customLint);
 
     // Report info problems.
     core.startGroup('Dart Analyzer - Infos');