ci: Add custom eslint command

Author: thelukewalton

README.md

@@ -88,19 +88,20 @@ export default {
 
 ## Inputs
 
-| Name                | Description                                                         | Required | Default                     |
-| ------------------- | ------------------------------------------------------------------- | -------- | --------------------------- |
-| token               | Token used for pushing fixes and commenting on PRs.                 | true     |                             |
-| working-directory   | Working directory to run the action in                              | false    | "."                         |
-| web-components-src  | The path to the directory containing the web components source code | false    | "src/\*_/_.{ts,tsx}"        |
-| test-src            | The path to the directory containing the test source code           | false    | "src/test/\*_/_.test.ts"    |
-| test-results-path   | The path to the test results file                                   | false    | "./test-results.xml"        |
-| coverage-path       | The path to the coverage file                                       | false    | "coverage/lcov.info"        |
-| run-static-analysis | Whether to run static analysis                                      | false    | true                        |
-| run-code-formatting | Whether to run code formatting                                      | false    | true                        |
-| run-tests           | Whether tests should be run.                                        | false    | true                        |
-| run-coverage        | Whether to run coverage                                             | false    | true                        |
-| create-comment      | Whether to create a comment on the PR                               | false    | true                        |
-| coverage-pass-score | The minimum coverage score required to pass                         | false    | "80"                        |
-| eslint-config-path  | The path to the ESLint configuration file                           | false    | "eslint.config.\*"          |
-| test-config-path    | The path to the test configuration file                             | false    | "web-test-runner.config.\*" |
+| Name                | Description                                                         | Required | Default                                                               |
+| ------------------- | ------------------------------------------------------------------- | -------- | --------------------------------------------------------------------- |
+| token               | Token used for pushing fixes and commenting on PRs.                 | true     |                                                                       |
+| working-directory   | Working directory to run the action in                              | false    | "."                                                                   |
+| web-components-src  | The path to the directory containing the web components source code | false    | "src/\*_/_.{ts,tsx}"                                                  |
+| test-src            | The path to the directory containing the test source code           | false    | "src/test/\*_/_.test.ts"                                              |
+| test-results-path   | The path to the test results file                                   | false    | "./test-results.xml"                                                  |
+| coverage-path       | The path to the coverage file                                       | false    | "coverage/lcov.info"                                                  |
+| run-static-analysis | Whether to run static analysis                                      | false    | true                                                                  |
+| run-code-formatting | Whether to run code formatting                                      | false    | true                                                                  |
+| run-tests           | Whether tests should be run.                                        | false    | true                                                                  |
+| run-coverage        | Whether to run coverage                                             | false    | true                                                                  |
+| create-comment      | Whether to create a comment on the PR                               | false    | true                                                                  |
+| coverage-pass-score | The minimum coverage score required to pass                         | false    | "80"                                                                  |
+| eslint-config-path  | The path to the ESLint configuration file                           | false    | "eslint.config.\*"                                                    |
+| test-config-path    | The path to the test configuration file                             | false    | "web-test-runner.config.\*"                                           |
+| eslint-cmd          | The command used for eslint                                         | false    | "npx eslint -f unix $web-components-src --config $eslint-config-path" |

action.yml

@@ -80,6 +80,10 @@ inputs:
     required: false
     default: "web-test-runner.config.*"
 
+  eslint-cmd:
+    description: "The command to run ESLint"
+    required: false
+    default: ""
 runs:
   using: node20
   main: dist/index.js

src/main.ts

@@ -204,6 +204,7 @@ const getInputs = (
   boolean,
   string,
   string,
+  string,
 ] => {
   // get the token and octokit
   let token = "";
@@ -263,6 +264,8 @@ const getInputs = (
     ? "web-test-runner.config.*"
     : getInput("test-config-path");
 
+  const esLintCmd: string = isLocal ? "" : getInput("eslint-cmd");
+
   return [
     token,
     workingDirectory,
@@ -278,6 +281,7 @@ const getInputs = (
     createComment,
     eslintConfigPath,
     testConfigPath,
+    esLintCmd,
   ];
 };
 
@@ -322,6 +326,7 @@ export async function run(): Promise<void> {
       createComment,
       eslintConfigPath,
       testConfigPath,
+      esLintCmd,
     ] = getInputs(isLocal);
 
     // Check if the working directory is different from the current directory
@@ -339,11 +344,12 @@ export async function run(): Promise<void> {
     const eslintStr: StepResponse | undefined = doStaticAnalysis
       ? await eslint({
           label: "ESLint",
-          command:
-            "npx eslint -f unix " +
-            wcSrcDirectory +
-            " --config " +
-            eslintConfigPath,
+          command: esLintCmd.isEmpty()
+            ? "npx eslint -f unix " +
+              wcSrcDirectory +
+              " --config " +
+              eslintConfigPath
+            : esLintCmd,
         })
       : undefined;