Add --offline flag and replace elm-json by elm-solve-deps-wasm

CHANGELOG.md

@@ -2,7 +2,13 @@
 
 ## [Unreleased]
 
-- Fixed a crash when using `--template` from the same repository but from two different paths. 
+## [2.11.0] **BETA** - 2023-10-16
+
+- Add an `offline` mode to prevent `elm-review` from making any HTTP requests. This is useful for CI environments that should not have access to the internet, where you only want to run `elm-review` without arguments.
+- Replaced the internally used `elm-json` dependency with `elm-solve-deps-wasm`, which should be more reliable, re-enable support for old MacOS versions as well as improve performance.
+- Fixed a crash when using `--template` from the same repository but from two different paths.
+
+This is a **BETA** release, so I expect things to break. Please report any issues you encounter on the #elm-review channel on the Elm Slack.
 
 ## [2.10.3] - 2023-09-26
 

documentation/tooling-integration.md

@@ -18,7 +18,7 @@ The CLI creates a bunch of cache inside `elm-stuff/generated-code/jfmengels/elm-
 - `file-cache/`: Caching of the file's ASTs.
 - `review-applications/`: Caching of the project's configuration. This is the application we build by compiling the source code in the CLI's `template/` directory.
 - `result-cache/`: Caching of the results of each module's analysis for every rule.
-- `dependencies-cache/`: Caching of the dependencies of the project's configuration computed by `elm-json`. `elm-json` is a bit slow, and doesn't work great offline. This is done so we don't have to compute the dependencies again if the configuration changed but not `review/elm.json`.
+- `dependencies-cache/`: Caching of data related to Elm dependencies computed by `elm-solve-deps-wasm` (or `elm-json` prior to `2.11.0`).
 - `elm-parser/`: Caching of the parser application. This is the application we build by compiling with the user's version of `stil4m/elm-syntax`, and the name of the file reflect the version. This is used to parallelize the parsing of the files, which is kind of slow, at startup.
 
 Namespacing things means that data will unfortunately be duplicated, but it is meant to prevent different tools from stepping on each other's toes by saving the same files at the same time as another, potentially corrupting the files.

lib/build.js

@@ -22,6 +22,7 @@ const TemplateDependencies = require('./template-dependencies');
  * @typedef { import("./types/build").BuildResult } BuildResult
  * @typedef { import("./types/build").AppHash } AppHash
  * @typedef { import("./types/build").ReviewElmJson } ReviewElmJson
+ * @typedef { import("./types/elm-version").ElmVersion } ElmVersion
  * @typedef { import("./types/path").Path } Path
  */
 
@@ -159,13 +160,7 @@ I can help set you up with an initial configuration if you run ${chalk.magenta('
 
     const buildResult = await Promise.all([
       getElmBinary(options),
-      createTemplateProject(
-        options,
-        reviewElmJsonPath,
-        userSrc,
-        buildFolder,
-        reviewElmJson
-      )
+      createTemplateProject(options, userSrc, buildFolder, reviewElmJson)
     ]).then(([elmBinary]) => {
       Debug.log('Compiling review application');
       Benchmark.start(options, 'Compile review project');
@@ -257,7 +252,6 @@ async function buildFromGitHubTemplate(options, template) {
       getElmBinary(options),
       createTemplateProject(
         options,
-        reviewElmJsonPath,
         buildFolder,
         path.join(buildFolder, 'project'),
         reviewElmJsonWithReplacedParentDirectories
@@ -294,15 +288,13 @@ async function buildFromGitHubTemplate(options, template) {
 /**
  * Create a local temporary project to build an Elm application in.
  * @param {Options} options
- * @param {Path} reviewElmJsonPath
  * @param {Path} userSrc
  * @param {Path} projectFolder
  * @param {ReviewElmJson} reviewElmJson
  * @returns {Promise<void>}
  */
 async function createTemplateProject(
   options,
-  reviewElmJsonPath,
   userSrc,
   projectFolder,
   reviewElmJson
@@ -312,17 +304,14 @@ async function createTemplateProject(
   const elmJsonPath = path.join(projectFolder, 'elm.json');
 
   // Load review project's elm.json file contents
-  const [dependencies, previousElmJson] = await Promise.all([
-    TemplateDependencies.get(
-      options,
-      reviewElmJson.dependencies,
-      reviewElmJsonPath
-    ),
-    FS.readFile(elmJsonPath).catch(() => null)
+  const [previousElmJson, dependencies] = await Promise.all([
+    FS.readFile(elmJsonPath).catch(() => null),
+    TemplateDependencies.addRequiredDependencies(options, reviewElmJson)
   ]);
   const finalElmJson = updateSourceDirectories(options, userSrc, {
     ...reviewElmJson,
-    dependencies
+    dependencies,
+    'test-dependencies': {direct: {}, indirect: {}}
   });
   const finalElmJsonAsString = JSON.stringify(finalElmJson, null, 4);
   if (previousElmJson !== finalElmJsonAsString) {
@@ -558,38 +547,14 @@ async function buildElmParser(options, reviewElmJson) {
 
   Debug.log(`Building parser app for elm-syntax v${elmSyntaxVersion}`);
 
-  const parseElmElmJsonPath = path.resolve(parseElmFolder, 'elm.json');
-  const parseElmElmJson = await FS.readJsonFile(parseElmElmJsonPath).catch(
-    (error) => {
-      if (error.code === 'ENOENT') {
-        return Promise.reject(
-          new ErrorMessage.CustomError(
-            // prettier-ignore
-            'UNEXPECTED INTERNAL ERROR',
-            // prettier-ignore
-            `I was expecting to find the "parseElm" project at ${chalk.cyan(parseElmElmJsonPath)} but could not find it.
-
-Please open an issue at the following link:
-https://github.com/jfmengels/node-elm-review/issues/new
-`,
-            options.elmJsonPath
-          )
-        );
-      }
-
-      return Promise.reject(error);
-    }
-  );
-
   const buildFolder = options.buildFolderForParserApp();
 
   const [elmBinary] = await Promise.all([
     getElmBinary(options),
     createParserElmJsonFile(
       options,
       buildFolder,
-      parseElmElmJson,
-      parseElmElmJsonPath,
+      reviewElmJson['elm-version'],
       elmSyntaxVersion
     ),
     // Needed when the user has `"type": "module"` in their package.json.
@@ -612,33 +577,36 @@ https://github.com/jfmengels/node-elm-review/issues/new
   );
 }
 
+/** Create `elm.json` file for the parser application, which will use the exact same version
+ * of `stil4m/elm-syntax` as the review application.
+ *
+ * @param {Options} options
+ * @param {Path} buildFolder
+ * @param {ElmVersion} elmVersion
+ * @param {ElmVersion} elmSyntaxVersion
+ * @return {Promise<void>}
+ */
 async function createParserElmJsonFile(
   options,
   buildFolder,
-  parseElmElmJson,
-  parseElmElmJsonPath,
+  elmVersion,
   elmSyntaxVersion
 ) {
-  const dependencies = await TemplateDependencies.addElmSyntax(
+  /** @type {ReviewElmJson} */
+  const parseElmElmJson = await TemplateDependencies.addElmSyntax(
     options,
-    parseElmElmJsonPath,
+    elmVersion,
     elmSyntaxVersion
   );
 
+  parseElmElmJson['source-directories'] = parseElmElmJson[
+    'source-directories'
+  ].map((dir) => path.resolve(parseElmFolder, dir));
+
   await FS.mkdirp(buildFolder);
   return FS.writeFile(
     path.resolve(buildFolder, 'elm.json'),
-    JSON.stringify(
-      {
-        ...parseElmElmJson,
-        dependencies,
-        'source-directories': parseElmElmJson['source-directories'].map((dir) =>
-          path.resolve(parseElmFolder, dir)
-        )
-      },
-      null,
-      2
-    )
+    JSON.stringify(parseElmElmJson, null, 2)
   );
 }