Replace shell scripts by JavaScript tests (#325)

.eslintrc.js

@@ -162,7 +162,7 @@ module.exports = {
   },
   overrides: [
     {
-      files: ['./*.js'],
+      files: ['**/*.js', '**/*.mjs'],
       rules: {
         // Not compatible with JSDoc according https://github.com/typescript-eslint/typescript-eslint/issues/8955#issuecomment-2097518639
         '@typescript-eslint/explicit-function-return-type': 'off',

documentation/tooling-integration.md

@@ -169,7 +169,7 @@ In that case, we (should) still report errors as JSON, with the following format
 - `message`: The description of the problem. It is an array like `formatted` for review errors, even though at this moment it only contains a string that has been trimmed and where colors have been removed.
 - `stack` (optional): The original JavaScript runtime stacktrace. Only sent if you run with `--debug`.
 
-You should only have to listen to the CLI's standard output (`stdout`), and should not have to listen to the standard error output (`stderr`).
+You should only have to listen to the CLI's standard output stream (`stdout`), and should not listen to the standard error stream (`stderr`).
 
 ## Things that may help you
 

lib/main.js

@@ -1,3 +1,4 @@
+// TODO(@lishaduck): Create a `setup` function.
 process.title = 'elm-review';
 
 if (!process.argv.includes('--no-color')) {
@@ -34,8 +35,10 @@ const Watch = require('./watch');
 /**
  * @type {Options}
  */
+// TODO(@lishaduck): Centralize all calls to just this & move into main.
 const options = AppState.getOptions();
 
+// TODO(@lishaduck): Move to aforementioned `setup` function.
 process.on('uncaughtException', errorHandler);
 process.on('unhandledRejection', errorHandler);
 

lib/types/json.ts

@@ -1,9 +1,9 @@
 /**
- * A replacer function for JSON.stringify.
+ * A replacer function for {@linkcode JSON.stringify}.
  */
 export type Replacer = (key: string, value: unknown) => unknown;
 
 /**
- * A reviver function for JSON.parse.
+ * A reviver function for {@linkcode JSON.parse}.
  */
 export type Reviver = (key: string, value: unknown) => unknown;

lib/types/options.ts

@@ -7,7 +7,7 @@ export type OptionsBase = {
   enableExtract: boolean;
   unsuppress: boolean | string[];
   detailsMode: DetailsMode;
-  report: ReportMode;
+  report: ReportMode | null;
   rulesFilter: string[] | null;
   ignoreProblematicDependencies: boolean;
 };

package.json

@@ -54,9 +54,9 @@
     "prettier-check": "prettier . --check --cache",
     "prettier-fix": "prettier . --write --cache",
     "test": "turbo run testing check-engines --continue",
-    "test-sync": "npm run test-run && npm run jest",
-    "test-run": "(cd test/ && ./run.sh)",
-    "test-run-record": "(cd test/ && ./run.sh record)",
+    "test-sync": "npm run jest && npm run test-run",
+    "test-run": "(cd test/ && node ./run.mjs)",
+    "test-run-record": "(cd test/ && node ./run.mjs record)",
     "tsc": "tsc",
     "tsc-watch": "tsc --watch"
   },
@@ -111,7 +111,8 @@
     "ls-engines": "^0.9.3",
     "prettier": "^2.8.8",
     "turbo": "^2.2.3",
-    "typescript": "~5.6.3"
+    "typescript": "~5.6.3",
+    "zx": "^8.2.4"
   },
   "packageManager": "[email protected]+sha512.dc700d97c8bd0ca9d403cf4fe0a12054d376f048d27830a6bc4a9bcce02ec42143cdd059ce3525f7dce09c6a4e52e9af5b996f268d8729c8ebb1cfad7f2bf51f",
   "engines": {

test/jest-helpers/cli.js

@@ -55,6 +55,7 @@ async function internalExec(args, options = {}) {
   const colorFlag = 'FORCE_COLOR=' + (options.colors ? '1' : '0');
 
   try {
+    // If this just uses child_process.exec, the shell scripts are pointless, and should be all migrated to Jest tests.
     const result = await exec(
       [colorFlag, cli, reportMode(options), colors(options), args].join(' '),
       {

test/run-snapshots/init-project/src/Main.elm

@@ -1,4 +1,3 @@
 module A exposing (..)
 import Html exposing (text)
 main = text "Hello!"
-

test/run-snapshots/init-template-project/src/Main.elm

@@ -1,4 +1,3 @@
 module A exposing (..)
 import Html exposing (text)
 main = text "Hello!"
-