chore: enable no-implicit-any on review-dependencies.js

jfmengels · Nov 4, 2024 · 1fd229c · 1fd229c
1 parent 01e2f25
commit 1fd229c
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/lib/review-dependencies.js b/lib/review-dependencies.js
@@ -1,5 +1,14 @@
+/**
+ * @import {ApplicationDependencyList, PackageElmJson, PackageName} from './types/content';
+ * @import {VersionString} from './types/version';
+ */
+
 const ProjectJsonFiles = require('./project-json-files');
 
+/**
+ * @param {ApplicationDependencyList} reviewDirectDependencies
+ * @param {VersionString} elmVersion
+ */
 async function collectRuleLinks(reviewDirectDependencies, elmVersion) {
   const elmJsonForReviewDependenciesPromises = Object.entries(
     reviewDirectDependencies
@@ -24,6 +33,10 @@ async function collectRuleLinks(reviewDirectDependencies, elmVersion) {
   );
 }
 
+/**
+ * @param {ApplicationDependencyList} reviewDirectDependencies
+ * @param {PackageElmJson[]} elmJsonForReviewDependencies
+ */
 function computeLinksToRuleDocs(
   reviewDirectDependencies,
   elmJsonForReviewDependencies
@@ -42,19 +55,28 @@ function computeLinksToRuleDocs(
         ? dep['exposed-modules']
         : Object.values(dep['exposed-modules']).reduce((acc, items) => [
             ...acc,
-            items
+            ...items
           ]);
 
       for (const moduleName of exposedModules) {
-        acc[moduleName] = linkToModule(depName, packageVersion, moduleName);
+        acc[moduleName] = linkToModule(
+          /** @type {PackageName} */ (depName),
+          packageVersion,
+          moduleName
+        );
       }
 
       return acc;
     },
-    {}
+    /** @type {Record<string, string>} */ ({})
   );
 }
 
+/**
+ * @param {PackageName} dependencyName
+ * @param {VersionString} packageVersion
+ * @param {string} moduleName
+ */
 function linkToModule(dependencyName, packageVersion, moduleName) {
   const urlModuleName = moduleName.split('.').join('-');
   return `https://package.elm-lang.org/packages/${dependencyName}/${packageVersion}/${urlModuleName}`;

diff --git a/lib/types/content.ts b/lib/types/content.ts
@@ -54,7 +54,7 @@ export type PackageElmJson = {
   summary: string;
   license: string;
   version: VersionString;
-  'exposed-modules': (string | Record<string, string>)[];
+  'exposed-modules': string[] | Record<string, string[]>;
   'elm-version': VersionRange;
   dependencies: PackageDependencyList;
   'test-dependencies': PackageDependencyList;

diff --git a/tsconfig.no-implicit-any.json b/tsconfig.no-implicit-any.json
@@ -35,6 +35,7 @@
     "lib/result-cache.js",
     "lib/result-cache-json.js",
     "lib/result-cache-worker.js",
+    "lib/review-dependencies.js",
     "lib/spinner.js",
     "lib/state.js",
     "lib/styled-message.js",