Add types to options.js

lib/anonymize.js

@@ -20,12 +20,12 @@ module.exports = {
 /**
  * Strip the version and paths out of the given string.
  * This is only used for tests to make them pass even when the version/paths change.
- * @param {Options} options
+ * @param {Options | null} options
  * @param {string} string
  * @returns {string}
  */
 function pathsAndVersions(options, string) {
-  if (options.forTests) {
+  if (options && options.forTests) {
     const root = path.dirname(__dirname);
     return replaceVersion(string.split(root).join('<local-path>'));
   }

lib/error-message.js

@@ -22,13 +22,13 @@ class CustomError extends Error {
 }
 
 /**
- * @param {Options} options
+ * @param {Options | null} options
  * @param {CustomError} err
  * @param {Path} [defaultPath]
  * @returns {string}
  */
 function report(options, err, defaultPath) {
-  if (options.report === 'json') {
+  if (options && options.report === 'json') {
     return Anonymize.pathsAndVersions(
       options,
       Anonymize.pathsAndVersions(
@@ -42,7 +42,10 @@ function report(options, err, defaultPath) {
     );
   }
 
-  return Anonymize.pathsAndVersions(options, formatHuman(options.debug, err));
+  return Anonymize.pathsAndVersions(
+    options,
+    formatHuman(options?.debug ?? false, err)
+  );
 }
 
 /**

lib/options.js

@@ -45,9 +45,12 @@ function compute(processArgv) {
     alias: Flags.flags
       .filter((flag) => flag.alias)
       .reduce((object, flag) => {
-        object[flag.name] = flag.alias;
+        if (flag.alias) {
+          object[flag.name] = flag.alias;
+        }
+
         return object;
-      }, {}),
+      }, /** @type {Record<string, string>} */ ({})),
     boolean: Flags.flags
       .filter((flag) => flag.boolean)
       .map((flag) => flag.name),
@@ -201,7 +204,7 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
     forceBuild: args['force-build'],
     report: args.report === 'json' || args.report === 'ndjson' ? 'json' : null,
     reportOnOneLine: args.report === 'ndjson',
-    rulesFilter: listOfStrings(args.rules),
+    rulesFilter: listOfStrings(args.rules) || [],
     ignoredDirs: listOfStrings(args['ignore-dirs']) || [],
     ignoredFiles: listOfStrings(args['ignore-files']) || [],
 
@@ -289,14 +292,24 @@ try re-running it with ${chalk.cyan('--elmjson <path-to-elm.json>')}.`,
   };
 }
 
+/**
+ *
+ * @param {minimist.ParsedArgs} args
+ * @returns {boolean}
+ */
 function parseUnsuppress(args) {
   if (args.unsuppress) {
     return true;
   }
 
-  return listOfStrings(args['unsuppress-rules']) || false;
+  return Boolean(listOfStrings(args['unsuppress-rules']));
 }
 
+/**
+ *
+ * @param {string | string[]} input
+ * @returns {string[] | null}
+ */
 function listOfStrings(input) {
   if (typeof input === 'string') {
     return input.split(',');
@@ -305,13 +318,19 @@ function listOfStrings(input) {
   if (Array.isArray(input)) {
     return input.reduce(
       (acc, subArray) => [...acc, ...subArray.split(',')],
-      []
+      /** @type {string[]} */ ([])
     );
   }
 
   return null;
 }
 
+/**
+ *
+ * @param {Subcommand | null} subcommand
+ * @param {string} string
+ * @returns {{ repoName: string, pathToFolder: string, reference: string }}
+ */
 function parseTemplate(subcommand, string) {
   const match = /([^/]+\/[^#/]+)(\/[^#]+)?(#(.+))?/.exec(string);
   if (!match) {
@@ -338,6 +357,12 @@ ${Flags.buildFlag(subcommand, Flags.templateFlag)}`
   };
 }
 
+/**
+ *
+ * @param {minimist.ParsedArgs} args
+ * @param {Subcommand | null} subcommand
+ * @returns {string | null}
+ */
 function findElmJsonPath(args, subcommand) {
   if (args.elmjson) return args.elmjson;
   // Shortcutting the search for elm.json when `--help` since we won't need it
@@ -355,6 +380,10 @@ function findElmJsonPath(args, subcommand) {
   return findUp.sync('elm.json') || null;
 }
 
+/**
+ *
+ * @returns {(flag: string) => true}
+ */
 function unknownCheck() {
   const allFlagNames = new Set(Flags.flags.map((flag) => flag.name));
 
@@ -376,6 +405,11 @@ function unknownCheck() {
   };
 }
 
+/**
+ *
+ * @param {string} name
+ * @returns {string}
+ */
 function unknownFlagMessage(name) {
   if (name === 'suppress') {
     const orange = chalk.keyword('orange');
@@ -403,6 +437,11 @@ function unknownFlagMessage(name) {
   ].join('\n');
 }
 
+/**
+ *
+ * @param {string} flag
+ * @returns {true}
+ */
 function unknownShortHandFlagCheck(flag) {
   const flagRegex = /^-(?<name>\w+)/;
   const match = flagRegex.exec(flag);
@@ -442,6 +481,11 @@ function unknownShortHandFlagCheck(flag) {
   return true;
 }
 
+/**
+ *
+ * @param {string} flag
+ * @returns {string[]}
+ */
 function suggestions(flag) {
   return Flags.flags
     .map((f) => ({
@@ -463,6 +507,11 @@ function suggestions(flag) {
     .map((f) => chalk.greenBright(`    --${f.name}${Flags.buildFlagsArgs(f)}`));
 }
 
+/**
+ *
+ * @param {Subcommand | null} subcommand
+ * @param {minimist.ParsedArgs} args
+ */
 function checkForMissingArgs(subcommand, args) {
   Flags.flags
     .filter((flag) => flag.boolean === false)
@@ -502,6 +551,11 @@ ${Flags.buildFlag(subcommand, flag)}`
     });
 }
 
+/**
+ *
+ * @param {Subcommand | null} subcommand
+ * @param {minimist.ParsedArgs} args
+ */
 function checkForInvalidArgs(subcommand, args) {
   if (args.report && !['json', 'ndjson', 'human'].includes(args.report)) {
     reportErrorAndExit(
@@ -519,6 +573,12 @@ ${Flags.buildFlag(subcommand, Flags.reportFlag)}`
   }
 }
 
+/**
+ *
+ * @param {Subcommand | null} subcommand
+ * @param {string} gitHubAuth
+ * @returns {{ gitHubUser: string, gitHubPassword: string }}
+ */
 function parseGitHubAuth(subcommand, gitHubAuth) {
   const split = gitHubAuth.split(':');
   if (split.length !== 2) {
@@ -540,9 +600,12 @@ ${Flags.buildFlag(subcommand, Flags.gitHubAuthFlag)}`
   return {gitHubUser, gitHubPassword};
 }
 
+/**
+ *
+ * @param {ErrorMessage.CustomError} errorToReport
+ */
 function reportErrorAndExit(errorToReport) {
-  // @ts-expect-error - Handle this later
-  console.log(ErrorMessage.report({}, errorToReport));
+  console.log(ErrorMessage.report(null, errorToReport));
 
   process.exit(1);
 }

lib/types/options.d.ts

@@ -48,9 +48,9 @@ export type Options = {
   templateElmModulePath: (string) => Path;
   pathToTemplateElmJson: (string) => Path;
   dependenciesCachePath: () => Path;
-  elmJsonPath: Path;
+  elmJsonPath: Path | null;
   elmJsonPathWasSpecified: boolean;
-  readmePath: Path;
+  readmePath: Path | null;
   projectToReview: () => Path;
   directoriesToAnalyze: Path[];
   fileCachePath: () => Path;

tsconfig.no-implicit-any.json

@@ -11,6 +11,7 @@
     "lib/hash.js",
     "lib/help.js",
     "lib/os-helpers.js",
+    "lib/options.js",
     "jest.config.js"
   ]
 }