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

@@ -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,

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/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) {

lib/remote-template.js

@@ -18,6 +18,8 @@ const TemplateDependencies = require('./template-dependencies');
 // GET LATEST INFORMATION ABOUT REPOSITORY
 
 /**
+ * @param {Options} options
+ * @param {Template} template
  * @returns {Promise<string>}
  */
 async function getRelevantCommit(options, template) {
@@ -36,33 +38,42 @@ async function getRelevantCommit(options, template) {
 
 /**
  * @returns {Promise<string>}
+ * @param {Options} options
+ * @param {Template} template
  */
 async function findDefaultBranch(options, template) {
   Debug.log('Fetching default branch');
-  const body = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${template.repoName}`,
-    () => repoNotFoundErrorMessage(template.repoName)
+  const body = /** @type {{default_branch: string}} */ (
+    await makeGitHubApiRequest(
+      options,
+      `https://api.github.com/repos/${template.repoName}`,
+      () => repoNotFoundErrorMessage(template.repoName)
+    )
   );
   return body.default_branch;
 }
 
 /**
  * @returns {Promise<string>}
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} reference
  */
 async function getLatestCommitForReference(options, template, reference) {
   Debug.log(`Fetching commit ${reference}`);
-  const body = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${template.repoName}/commits/${reference}`,
-    (responseBody) => {
-      if (responseBody.message === 'Not Found') {
-        // This error means that the repo itself was not found
-        return repoNotFoundErrorMessage(template.repoName);
-      }
+  const body = /** @type {{sha: string}} */ (
+    await makeGitHubApiRequest(
+      options,
+      `https://api.github.com/repos/${template.repoName}/commits/${reference}`,
+      (responseBody) => {
+        if (responseBody.message === 'Not Found') {
+          // This error means that the repo itself was not found
+          return repoNotFoundErrorMessage(template.repoName);
+        }
 
-      return commitNotFoundErrorMessage(template.repoName, reference);
-    }
+        return commitNotFoundErrorMessage(template.repoName, reference);
+      }
+    )
   );
   return body.sha;
 }
@@ -108,6 +119,10 @@ async function getRemoteElmJson(
   return TemplateDependencies.update(options, elmJson);
 }
 
+/**
+ * @param {Template} template
+ * @param {string} commit
+ */
 async function downloadTemplateElmJson(template, commit) {
   const {repoName, pathToFolder} = template;
   const pathToFolderAsUrl = pathToFolder ? `/${pathToFolder}` : '';
@@ -165,6 +180,9 @@ elm-review in your project:
     elm-review init --template <some-configuration>`
 };
 
+/**
+ * @param {string} repoName
+ */
 function repoNotFoundErrorMessage(repoName) {
   return {
     title: 'REPOSITORY NOT FOUND',
@@ -176,6 +194,10 @@ with private ones at the moment.`
   };
 }
 
+/**
+ * @param {unknown} repoName
+ * @param {unknown} reference
+ */
 function commitNotFoundErrorMessage(repoName, reference) {
   return {
     title: 'BRANCH OR COMMIT NOT FOUND',
@@ -189,6 +211,13 @@ Check the spelling and make sure it has been pushed.`
 
 // DOWNLOAD TEMPLATE FILES
 
+/**
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} commit
+ * @param {string} basePath
+ * @param {ApplicationElmJson} reviewElmJson
+ */
 async function downloadSourceDirectories(
   options,
   template,
@@ -209,6 +238,13 @@ async function downloadSourceDirectories(
   );
 }
 
+/**
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} commit
+ * @param {string} basePath
+ * @param {string} directory
+ */
 async function downloadDirectory(
   options,
   template,
@@ -220,12 +256,15 @@ async function downloadDirectory(
   const destinationDirectory = directory.split('..').join('parent');
 
   await FS.mkdirp(path.join(basePath, destinationDirectory));
-  const fileListing = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${repoName}/contents${pathToFolder}/${directory}?ref=${commit}`
-      .split('//')
-      .join('/')
-  );
+  const fileListing =
+    /** @type {({ type: string; name: string; download_url: string; })[]} */ (
+      await makeGitHubApiRequest(
+        options,
+        `https://api.github.com/repos/${repoName}/contents${pathToFolder}/${directory}?ref=${commit}`
+          .split('//')
+          .join('/')
+      )
+    );
 
   await Promise.all(
     fileListing.map(async (fileOrDir) => {
@@ -283,7 +322,7 @@ async function downloadFile(url, dest) {
  * @param {Options} options
  * @param {string} url
  * @param {((arg: JsonResponse) => {title: string, message: string})} [handleNotFound]
- * @returns {Promise<object>}
+ * @returns {Promise<unknown>}
  */
 async function makeGitHubApiRequest(options, url, handleNotFound) {
   /** @type {OptionsOfJSONResponseBody}} */

lib/result-cache-worker.js

@@ -1,3 +1,6 @@
+/**
+ * @import {MessagePort} from 'node:worker_threads';
+ */
 const path = require('node:path');
 const {parentPort} = require('node:worker_threads');
 const fs = require('graceful-fs');
@@ -7,6 +10,9 @@ if (parentPort) {
   subscribe(parentPort);
 }
 
+/**
+ * @param {MessagePort} parentPort
+ */
 function subscribe(parentPort) {
   parentPort.on('message', ({filePath, cacheEntry, cacheKey}) => {
     try {
@@ -17,7 +23,9 @@ function subscribe(parentPort) {
       filePath,
       JSON.stringify(cacheEntry, ResultCacheJson.replacer, 0),
       'utf8',
-      () => parentPort?.postMessage(cacheKey)
+      () => {
+        parentPort?.postMessage(cacheKey);
+      }
     );
   });
 }