chore: tag todo comments with additional info

Make them full sentences.
Indent wrapped lines.
List the person blamed for adding it.
Update some dates.

Author: lishaduck

.eslintrc.js

@@ -1,7 +1,7 @@
-// TODO [eslint@>9.5]: Use `.ts` extension to get more type checking for this file.
-// TODO [engine:node@>=18]: Upgrade `tseslint`.
-// TODO [engine:node@>=18]: Use `eslint-define-config` to get type checking for this file.
-// TODO [engine:node@>=18]: Use `eslint-plugin-jsdoc` to get JSDoc linting.
+// TODO(@lishaduck) [eslint@>9.5]: Use `.ts` extension to get more type checking for this file.
+// TODO(@lishaduck) [engine:node@>=18]: Upgrade `tseslint`.
+// TODO(@lishaduck) [engine:node@>=18]: Use `eslint-define-config` to get type checking for this file.
+// TODO(@lishaduck) [engine:node@>=18]: Use `eslint-plugin-jsdoc` to get JSDoc linting.
 
 module.exports = {
   root: true,
@@ -67,7 +67,7 @@ module.exports = {
     '@typescript-eslint/switch-exhaustiveness-check': 'error',
     '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
     'default-case': 'off',
-    'n/shebang': 'off', // TODO [eslint-plugin-n@>=17]: Turn on 'n/hashbang'. For now, `shebang` is buggy.
+    'n/shebang': 'off', // TODO(@lishaduck) [eslint-plugin-n@>=17]: Turn on 'n/hashbang'. For now, `shebang` is buggy.
     '@eslint-community/eslint-comments/require-description': 'error',
     strict: ['error', 'global'],
     'unicorn/import-style': [
@@ -84,35 +84,35 @@ module.exports = {
     'unicorn/prevent-abbreviations': 'off',
     'no-fallthrough': 'off', // TS checks for this, and TSESLint doesn't provide an alternative.
 
-    // TODO: Once there are no more `any`s, start enforcing these rules.
+    // TODO(@lishaduck): Once there are no more `any`s, start enforcing these rules.
     '@typescript-eslint/no-unsafe-assignment': 'off',
     '@typescript-eslint/no-unsafe-argument': 'off',
     '@typescript-eslint/no-unsafe-member-access': 'off',
     '@typescript-eslint/no-unsafe-call': 'off',
     '@typescript-eslint/no-unsafe-return': 'off',
 
-    // TODO: Enable stricter promise rules.
+    // TODO(@lishaduck): Enable stricter promise rules.
     '@typescript-eslint/no-misused-promises': 'off',
     '@typescript-eslint/no-floating-promises': 'off',
     'promise/catch-or-return': 'off',
     'promise/always-return': 'off',
 
-    // TODO: Security issues that should eventually get fixed.
+    // TODO(@lishaduck): Security issues that should eventually get fixed.
     'security/detect-object-injection': 'off',
     'security/detect-non-literal-fs-filename': 'off',
     'security/detect-non-literal-require': 'off',
-    'security/detect-unsafe-regex': 'off', // TODO: Add `eslint-plugin-regexp` and fix these issues.
+    'security/detect-unsafe-regex': 'off', // TODO(@lishaduck): Add `eslint-plugin-regexp` and fix these issues.
 
-    // TODO: Enable rules that require newer versions of Node.js when we bump the minimum version.
-    'unicorn/prefer-string-replace-all': 'off', // TODO [engine:node@>=15]: Enable this rule.
-    'unicorn/prefer-at': 'off' // TODO [engine:node@>=16.6]: Enable this rule.
+    // TODO(@lishaduck): Enable rules that require newer versions of Node.js when we bump the minimum version.
+    'unicorn/prefer-string-replace-all': 'off', // TODO(@lishaduck) [engine:node@>=15]: Enable this rule.
+    'unicorn/prefer-at': 'off' // TODO(@lishaduck) [engine:node@>=16.6]: Enable this rule.
   },
   overrides: [
     {
       files: ['./new-package/**/*.js'],
       rules: {
         'n/no-process-exit': 'off',
-        '@typescript-eslint/unbound-method': 'off' // TODO: Fix this warning. @lishaduck just got confused.
+        '@typescript-eslint/unbound-method': 'off' // TODO(@lishaduck): Fix this warning. I just got confused.
       }
     }
   ],

bin/elm-review

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
 
-// TODO: With ESM, this should use TLA.
-
+// TODO(@lishaduck): With ESM, this should use TLA.
 require('../lib/main')();

lib/autofix.js

@@ -106,7 +106,7 @@ function askConfirmationToFixWithOptions(options, app, elmVersion) {
         filesToFix.map((file) => {
           const filePath = path.resolve(basePath, file.path);
           if (filePath.endsWith('.elm')) {
-            // TODO Make this async
+            // TODO(@jfmengels): Make this asynchronous.
             return formatFileContent(options, file, filePath);
           }
 
@@ -120,8 +120,8 @@ function askConfirmationToFixWithOptions(options, app, elmVersion) {
 
       let dependencies;
       if (modifiedElmJson) {
-        // TODO Check if source-directories have changed, and if so, load/unload the necessary files.
-        // TODO Check if dependencies have changed before we do this
+        // TODO(@jfmengels): Check if source-directories have changed, and if so, load/unload the necessary files.
+        // TODO(@jfmengels): Check if dependencies have changed before we do this.
         dependencies = await ProjectDependencies.collect(
           options,
           JSON.parse(modifiedElmJson.source),

lib/build.js

@@ -362,7 +362,7 @@ function unique(array) {
   return [...new Set(array)];
 }
 
-// TODO: TSify
+// TODO(@lishaduck): TSify these type definitions.
 /**
  * @typedef {object} CompileOptions
  * @property {string} cwd
@@ -490,7 +490,7 @@ function compilationError(options, stderr) {
       console.log(stderr);
     }
 
-    // TODO Handle this better
+    // TODO(@jfmengels): Handle this better.
 
     exit(1);
   }
@@ -579,7 +579,7 @@ async function buildElmParser(options, reviewElmJson) {
     ),
     // Needed when the user has `"type": "module"` in their package.json.
     // Our output is CommonJS.
-    // TODO: Switch to a .cjs file instead.
+    // TODO(@lishaduck): Switch to a .cjs file instead.
     FS.mkdirp(options.generatedCodePackageJson()).then(() =>
       FS.writeFile(
         path.join(options.generatedCodePackageJson(), 'package.json'),

lib/elm-binary.js

@@ -84,9 +84,9 @@ function downloadDependenciesOfElmJson(elmBinary, elmJsonPath) {
 
   if (result.status !== 0) {
     const error = JSON.parse(result.stderr.toString());
-    // TODO Check for other kinds of errors
+    // TODO(@jfmengels): Check for other kinds of errors.
     if (error.title !== 'NO INPUT') {
-      // TODO Print error nicely
+      // TODO(@jfmengels): Print the error nicely.
       throw new Error(error);
     }
   }

lib/elm-files.js

@@ -60,7 +60,7 @@ async function getProjectFiles(options, elmSyntaxVersion) {
     ({files}) => files.length === 0
   );
 
-  // TODO Have a different message depending on how directories were chosen (CLI directories, application, package)
+  // TODO(@jfmengels): Have a different message depending on how directories were chosen (CLI directories, application, package).
   if (options.directoriesToAnalyze.length > 0 && emptyDirectories.length > 0) {
     throw new ErrorMessage.CustomError(
       'NO FILES FOUND',

lib/error-message.js

@@ -105,8 +105,7 @@ function formatJson(debug, error, defaultPath) {
     type: 'error',
     title: error.title,
     path: error.path ?? defaultPath,
-    // TODO We currently strip the colors, but it would be nice to keep them
-    // so that editors can have nicer error messages
+    // TODO(@jfmengels): We currently strip the colors, but it would be nice to keep them so that editors can have nicer error messages.
     message: [stripAnsi(error.message.trim())],
     stack: debug && error.stack ? stripAnsi(error.stack) : undefined
   };

lib/init.js

@@ -1,6 +1,6 @@
 const fs = require('graceful-fs');
 const path = require('node:path');
-// TODO [engine:node@>=16.7.0]: Use native `cp`.
+// TODO(@lishaduck) [engine:node@>=16.7.0]: Use native `cp`.
 const fsExtra = require('fs-extra');
 const chalk = require('chalk');
 const prompts = require('prompts');

lib/module-cache.js

@@ -5,7 +5,7 @@ const Cache = require('./cache');
 
 function subscribe(options, app) {
   AppState.subscribe(app.ports.cacheFile, ({source, ast}) =>
-    // TODO Do this in a thread
+    // TODO(@jfmengels): Do this work in a thread.
     cacheFile(options, Hash.hash(source), ast)
   );
 }

lib/new-package.js

@@ -2,7 +2,7 @@ const path = require('node:path');
 const childProcess = require('node:child_process');
 const chalk = require('chalk');
 const prompts = require('prompts');
-// TODO [engine:node@>=16.7.0]: Use native `cp`.
+// TODO(@lishaduck) [engine:node@>=16.7.0]: Use native `cp`.
 const fsExtra = require('fs-extra');
 const Init = require('./init');
 const Spinner = require('./spinner');

lib/project-json-files.js

@@ -61,8 +61,8 @@ async function getElmJson(options, elmVersion, name, packageVersion) {
   }
 }
 
-// TODO Empty this cache at some point?
-// Note that we might need it in watch and fix mode, but not otherwise.
+// TODO(@jfmengels): Empty this cache at some point?
+//   Note that we might need it in watch and fix mode, but not otherwise.
 /** @type {Map<string, Promise<PackageElmJson>>} */
 const elmJsonInElmHomePromises = new Map();
 
@@ -177,7 +177,7 @@ async function readFromPackagesWebsite(
   packageVersion,
   file
 ) {
-  // TODO [engine:node@>=18]: We can use `fetch` now.
+  // TODO(@lishaduck) [engine:node@>=21]: We can use `fetch` now.
   const response = await got(
     `https://package.elm-lang.org/packages/${packageName}/${packageVersion}/${file}`
   );

lib/remote-template.js

@@ -103,7 +103,7 @@ async function downloadTemplateElmJson(template, commit) {
   const {repoName, pathToFolder} = template;
   const pathToFolderAsUrl = pathToFolder ? `/${pathToFolder}` : '';
 
-  // TODO [engine:node@>=18]: We can use `fetch` now.
+  // TODO(@lishaduck) [engine:node@>=21]: We can use `fetch` now.
   const response = await got(
     `https://raw.githubusercontent.com/${repoName}/${commit}${pathToFolderAsUrl}/elm.json`
   ).catch((error) => {
@@ -270,7 +270,7 @@ async function makeGitHubApiRequest(options, url, handleNotFound) {
 
   Debug.log(`Making API request to GitHub: ${url}`);
   try {
-    // TODO [engine:node@>=18]: We can use `fetch` now.
+    // TODO(@lishaduck) [engine:node@>=21]: We can use `fetch` now.
     const response = await got(url, parameters);
 
     return response.body;

lib/result-cache-json.js

@@ -9,7 +9,7 @@ function replacer(_key, value) {
   }
 
   if (typeof value === 'object') {
-    // TODO Serialize Dicts also
+    // TODO (@jfmengels): Also support serializing `Dict`s.
     // if (value.$ === -1) {
     //   return {
     //     $: '$D',

lib/result-cache.js

@@ -18,8 +18,9 @@ let worker = null;
 const resultCache = new Map();
 const promisesToResolve = new Map();
 
-// TODO Create an alternate version of Options used in elm-app-worker.
-// Depending on whether this is running in a worker or not, the options will be slightly different.
+// TODO(@jfmengels): Create an alternate version of Options used in
+//   `elm-app-worker`. Depending on whether this is running in a worker or not,
+//   the options will be slightly different.
 /**
  * Load cache results.
  *
@@ -30,7 +31,7 @@ const promisesToResolve = new Map();
  * @returns {Promise<void>}
  */
 async function load(options, ignoredDirs, ignoredFiles, cacheFolder) {
-  // TODO Make caching work for all of these
+  // TODO(@jfmengels): Make caching work for all of these combinations.
   if (
     options.debug ||
     options.directoriesToAnalyze.length > 0 ||

lib/watch.js

@@ -1,5 +1,5 @@
 const path = require('node:path');
-// TODO [engine:node@>=19.1] Use `fs.watch` (or `@parcel/watcher`).
+// TODO(@lishaduck) [engine:node@>=19.1]: Use `fs.watch` (or `@parcel/watcher`).
 const chokidar = require('chokidar');
 const Debug = require('./debug');
 const FS = require('./fs-wrapper');
@@ -94,8 +94,8 @@ function watchFiles(
             clearConsole();
           }
 
-          // TODO Detect what has changed and only re-load the necessary parts.
-          // We do some of this work in `autofix.js` already.
+          // TODO(@jfmengels): Detect what has changed and only re-load the necessary parts.
+          //   We do some of this work in `autofix.js` already.
           Debug.log('Your `elm.json` has changed. Restarting elm-review.');
         }
 
@@ -438,16 +438,17 @@ function createExtraFilesWatcher(options, app, runReview, onError, request) {
  */
 function createSuppressedFilesWatcher(options, app, onError) {
   function updateSuppressedErrors() {
-    // TODO Write last save time for each of these in appstate, and compare with the last update time
-    // that is given as argument to this function. If possible, don't do anything.
+    // TODO(@jfmengels): Write last save time for each of these in appstate,
+    //   and compare with the last update time that is given as argument to
+    //   this function. If possible, don't do anything.
     if (suppressedErrorsTimeout) {
       clearTimeout(suppressedErrorsTimeout);
     }
 
     suppressedErrorsTimeout = setTimeout(async () => {
       const suppressedErrors = await SuppressedErrors.read(options);
-      // TODO Avoid doing anything if suppressed errors haven't changed
-      //    It's likely this program's fault for changing anything anyway
+      // TODO(@jfmengels): Avoid doing anything if suppressed errors haven't
+      //   changed. It's likely this program's fault for changing anything anyway.
       Debug.log('Suppressed errors have been added');
       app.ports.updateSuppressedErrors.send(suppressedErrors);
     }, 20);

package.json

@@ -47,7 +47,7 @@
     "check-engines": "ls-engines --mode=ideal",
     "elm-format": "elm-format --validate ast-codec init-templates new-package parseElm review template",
     "elm-tests": "(cd template/ && elm make src/Elm/Review/Main.elm --output=/dev/null && elm-test)",
-    "eslint-check": "eslint . --report-unused-disable-directives --max-warnings=5",
+    "eslint-check": "eslint . --report-unused-disable-directives --max-warnings=2",
     "eslint-fix": "npm run eslint-check -- --fix",
     "jest": "npx jest",
     "prepare": "elm-tooling install",