More TS

lib/app-wrapper.js

@@ -109,9 +109,7 @@ function subscribe(port) {
 function unsubscribe(port) {
   // eslint-disable-next-line promise/prefer-await-to-callbacks -- Callbacks are still needed here.
   return (callback) => {
-    listeners[port] = listeners[port].filter(
-      (/** @type {Listened<unknown>} */ fn) => fn === callback
-    );
+    listeners[port] = listeners[port].filter((fn) => fn === callback);
   };
 }
 

lib/build.js

@@ -1,10 +1,10 @@
 /**
  * @import {AppHash, BuildResult} from './types/build';
- * @import {ApplicationElmJson} from './types/content';
+ * @import {ApplicationElmJson, ElmJson} from './types/content';
  * @import {VersionString} from './types/version';
  * @import {Options, Template} from './types/options';
  * @import {Path} from './types/path';
- * @import {CompileOptions} from '../vendor/types/node-elm-compiler';
+ * @import {CompileOptions, Sources} from '../vendor/types/node-elm-compiler';
  */
 const path = require('node:path');
 const crypto = require('node:crypto');
@@ -204,10 +204,7 @@ I can help set you up with an initial configuration if you run ${chalk.magenta('
  */
 async function buildFromGitHubTemplate(options, template) {
   Spinner.setText('Fetching template information');
-  const commit = await RemoteTemplate.getRelevantCommit(
-    options,
-    options.template
-  );
+  const commit = await RemoteTemplate.getRelevantCommit(options, template);
   const reviewElmJson = await RemoteTemplate.getRemoteElmJson(
     options,
     template,
@@ -333,6 +330,11 @@ async function createTemplateProject(
   Benchmark.end(options, 'Create template project');
 }
 
+/**
+ * @param {Options} options
+ * @param {string} userSrc
+ * @param {ApplicationElmJson} elmJson
+ */
 function updateSourceDirectories(options, userSrc, elmJson) {
   let sourceDirectories = [
     ...elmJson['source-directories'].map((directory) =>
@@ -355,13 +357,22 @@ function updateSourceDirectories(options, userSrc, elmJson) {
   };
 }
 
+/**
+ * @param {Options} options
+ * @param {string} dest
+ * @param {string} elmModulePath
+ * @param {Sources} compileTargets
+ * @param {string} elmBinary
+ * @param {boolean} isReviewApp
+ * @returns {Promise<string | null>}
+ */
 async function compileElmProject(
   options,
   dest,
   elmModulePath,
   compileTargets,
   elmBinary,
-  isReviewAppApp
+  isReviewApp
 ) {
   /** @type {CompileOptions} */
   const compileOptions = {
@@ -379,6 +390,7 @@ async function compileElmProject(
     }
   };
 
+  /** @type {string | null} */
   const resolvedElmModulePath = await new Promise((resolve) => {
     const compileProcess = elmCompiler.compile(compileTargets, compileOptions);
 
@@ -437,13 +449,13 @@ async function compileElmProject(
       }
     });
   });
-  return await OptimizeJs.optimize(
-    options,
-    resolvedElmModulePath,
-    isReviewAppApp
-  );
+  return await OptimizeJs.optimize(options, resolvedElmModulePath, isReviewApp);
 }
 
+/**
+ * @param {Options} options
+ * @param {string} stderr
+ */
 function compilationError(options, stderr) {
   if (stderr.includes('DEBUG REMNANTS')) {
     return {
@@ -457,7 +469,7 @@ function compilationError(options, stderr) {
     return {
       title: 'MODULE NOT FOUND',
       // prettier-ignore
-      message: `A module is missing in your configuration. Maybe you forgot to add some dependencies that contain the rules you wished to enable? If so, run ${chalk.magenta('elm install')} with the package name from inside ${chalk.yellow(options.userSrc(null))}.`
+      message: `A module is missing in your configuration. Maybe you forgot to add some dependencies that contain the rules you wished to enable? If so, run ${chalk.magenta('elm install')} with the package name from inside ${chalk.yellow(options.userSrc())}.`
     };
   }
 
@@ -480,6 +492,11 @@ function compilationError(options, stderr) {
   };
 }
 
+/**
+ * @param {Options} options
+ * @param {Path} reviewElmJsonPath
+ * @param {ElmJson} reviewElmJson
+ */
 function validateElmReviewVersion(options, reviewElmJsonPath, reviewElmJson) {
   if (options.localElmReviewSrc) {
     return;
@@ -533,6 +550,11 @@ of ${chalk.yellow(path.dirname(reviewElmJsonPath))}.`
   MinVersion.validate(options, reviewElmJsonPath, elmReviewVersion);
 }
 
+/**
+ * @param {Options} options
+ * @param {ApplicationElmJson} reviewElmJson
+ * @returns {Promise<void>}
+ */
 async function buildElmParser(options, reviewElmJson) {
   const elmSyntaxVersion =
     reviewElmJson.dependencies.direct['stil4m/elm-syntax'] ||
@@ -566,7 +588,7 @@ async function buildElmParser(options, reviewElmJson) {
     })
   ]);
 
-  return await compileElmProject(
+  await compileElmProject(
     options,
     buildFolder,
     elmParserPath,

lib/cache.js

@@ -6,7 +6,7 @@ const FS = require('./fs-wrapper');
 const AppState = require('./state');
 
 /**
- * @template {object} T
+ * @template T
  * @param {Path} folder
  * @param {string} key
  * @param {() => Promise<T | null>} fn
@@ -39,7 +39,7 @@ const ensuredFolders = new Set();
  * Cache a file on the filesystem.
  *
  * @param {string} filepath - Path to the file ending in ".json"
- * @param {object} content
+ * @param {unknown} content
  * @returns {Promise<void>}
  */
 async function cacheJsonFile(filepath, content) {

lib/elm-files.js

@@ -1,5 +1,5 @@
 /**
- * @import {ElmFile, Source, Readme, ElmJson, ElmJsonData, SourceDirectories} from './types/content';
+ * @import {ElmFile, Source, Readme, ElmJson, ElmJsonData, SourceDirectories, Ast} from './types/content';
  * @import {ReviewOptions} from './types/options';
  * @import {Path} from './types/path';
  */
@@ -189,7 +189,7 @@ async function readFile(
     path: OsHelpers.makePathOsAgnostic(relativeFilePath),
     source,
     lastUpdatedTime,
-    ast: cachedAst || (await readAst(options, elmParserPath, source))
+    ast: cachedAst ?? (await readAst(options, elmParserPath, source))
   };
 }
 
@@ -199,7 +199,7 @@ async function readFile(
  * @param {ReviewOptions} options
  * @param {Path} elmParserPath
  * @param {Source} source
- * @returns {Promise<ElmFile | null>}
+ * @returns {Promise<Ast | null>}
  */
 async function readAst(options, elmParserPath, source) {
   const hash = Hash.hash(source);

lib/fs-wrapper.js

@@ -1,6 +1,6 @@
 /**
- * @import {Path} from './types/path';
  * @import {Replacer, Reviver} from './types/json';
+ * @import {Path} from './types/path';
  */
 const fs = require('graceful-fs');
 const fsp = fs.promises;
@@ -51,7 +51,7 @@ async function readFile(file, options) {
  * Write a JSON file.
  *
  * @param {string} file
- * @param {object} content
+ * @param {unknown} content
  * @param {string | number | undefined} [space=undefined]
  * @param {Replacer | undefined} [replacer=undefined]
  * @returns {Promise<void>}

lib/min-version.js

@@ -8,9 +8,14 @@ const chalk = require('chalk');
 const ErrorMessage = require('./error-message');
 const PathHelpers = require('./path-helpers');
 
-const minimalVersion = {major: 2, minor: 14};
-// prettier-ignore
-const supportedRange = `${minimalVersion.major}.${minimalVersion.minor}.0 <= v < ${minimalVersion.major + 1}.0.0`
+const minimalVersion = /** @type {const} */ ({major: 2, minor: 14});
+
+// TS can't do arithmetic, so make sure the cast is right when bumping the major.
+const nextMajor = /** @type {3} */ (minimalVersion.major + 1);
+
+const supportedRange = /** @type {const} */ (
+  `${minimalVersion.major}.${minimalVersion.minor}.0 <= v < ${nextMajor}.0.0`
+);
 
 /**
  * If given an input version string smaller than the hardcoded `minimalVersion`,

lib/new-rule.js

@@ -194,10 +194,18 @@ async function addRule(options, elmJson, ruleName, ruleType) {
 
   if (elmJson.type === 'package' && packageNameRegex.test(elmJson.name)) {
     console.log('Exposing the rule in elm.json');
-    if (!elmJson['exposed-modules'].includes(ruleName)) {
+
+    const exposedModules = Array.isArray(elmJson['exposed-modules'])
+      ? elmJson['exposed-modules']
+      : Object.values(elmJson['exposed-modules']).reduce((acc, items) => [
+          ...acc,
+          ...items
+        ]);
+
+    if (!exposedModules.includes(ruleName)) {
       const newElmJson = {
         ...elmJson,
-        'exposed-modules': [...elmJson['exposed-modules'], ruleName].sort()
+        'exposed-modules': [...exposedModules, ruleName].sort()
       };
 
       writeFile(dir, 'elm.json', JSON.stringify(newElmJson, null, 4));

lib/optimize-js.js

@@ -1,17 +1,28 @@
+/**
+ * @import {Options} from './types/options';
+ * @import {Optimization} from './types/optimize-js';
+ */
+
 const Benchmark = require('./benchmark');
 const FS = require('./fs-wrapper');
 
-async function optimize(options, elmModulePath, isReviewAppApp) {
+/**
+ * @param {Options} options
+ * @param {string | null} elmModulePath
+ * @param {boolean} isReviewApp
+ * @returns {Promise<string | null>}
+ */
+async function optimize(options, elmModulePath, isReviewApp) {
   if (options.debug || !elmModulePath) {
     return elmModulePath;
   }
 
-  const timerId = isReviewAppApp
+  const timerId = isReviewApp
     ? 'optimizing review application'
     : 'optimizing parser application';
   Benchmark.start(options, timerId);
   const originalSource = await FS.readFile(elmModulePath);
-  const replacements = isReviewAppApp
+  const replacements = isReviewApp
     ? [
         ...performanceReplacements,
         ...cacheReplacements(options.localElmReviewSrc)
@@ -411,6 +422,10 @@ const performanceReplacements = [
   }
 ];
 
+/**
+ * @param {string | undefined} localElmReviewSrc
+ * @returns {Optimization[]}
+ */
 function cacheReplacements(localElmReviewSrc) {
   const packageName = localElmReviewSrc
     ? '$author$project'

lib/parse-elm.js

@@ -4,7 +4,7 @@
  */
 
 /**
- * @import {Source, ElmFile} from './types/content';
+ * @import {Source, ElmFile, Ast} from './types/content';
  * @import {ParseJob} from './types/parse-elm';
  * @import {Path} from './types/path';
  */
@@ -58,15 +58,17 @@ function terminateWorkers() {
 /**
  * @param {Path} elmParserPath
  * @param {Source} source
- * @returns {Promise<ElmFile>}
+ * @returns {Promise<Ast>}
  */
 async function parse(elmParserPath, source) {
   return await new Promise((resolve, reject) => {
     const availableWorker = findInactiveWorker();
+
     /** @type {ParseJob} */
     const queueItem = {
       source,
       elmParserPath,
+
       callback: (/** @type {Error | undefined} */ error, result) => {
         if (error === undefined) {
           resolve(result);

lib/project-dependencies.js

@@ -1,5 +1,16 @@
+/**
+ * @import {ElmJson} from './types/content';
+ * @import {Options} from './types/options';
+ * @import {VersionString} from './types/version';
+ */
+
 const ProjectJsonFiles = require('./project-json-files');
 
+/**
+ * @param {Options} options
+ * @param {ElmJson} elmJson
+ * @param {VersionString} elmVersion
+ */
 async function collect(options, elmJson, elmVersion) {
   const dependenciesEntries =
     elmJson.type === 'application'
@@ -19,7 +30,9 @@ async function collect(options, elmJson, elmVersion) {
 
   const projectDepsPromises = Object.entries(dependenciesEntries).map(
     async ([name, constraint]) => {
-      const packageVersion = constraint.split(' ')[0];
+      const packageVersion = /** @type {VersionString} */ (
+        constraint.split(' ')[0]
+      );
 
       const [docsJson, dependencyElmJson] = await Promise.all([
         ProjectJsonFiles.getDocsJson(
@@ -66,6 +79,10 @@ I will try to review the project anyway, but you might get unexpected results…
   return projectDeps;
 }
 
+/**
+ * @param {string} name
+ * @param {VersionString} packageVersion
+ */
 function defaultElmJson(name, packageVersion) {
   return {
     type: 'package',

lib/project-json-files.js

@@ -118,7 +118,7 @@ function getPackagePathInElmHome(elmVersion, name) {
  * @param {Options} options
  * @param {VersionString} elmVersion
  * @param {string} name
- * @param {string} packageVersion
+ * @param {VersionString} packageVersion
  * @returns {Promise<unknown>}
  */
 async function getDocsJson(options, elmVersion, name, packageVersion) {