From 2d9e21267d188501bc1233f092a4666e7ad23acd Mon Sep 17 00:00:00 2001
From: Efe <dogukankrskl@gmail.com>
Date: Wed, 30 Oct 2024 03:39:19 +0100
Subject: [PATCH] refactor(path): always name the parameters (add param
 definition check in doc linter) (#6158)

---
 _tools/check_docs.ts           | 43 ++++++++++++++++++++++++++++++++++
 path/posix/join_globs.ts       |  5 ++--
 path/posix/normalize_glob.ts   |  3 ++-
 path/windows/join_globs.ts     |  5 ++--
 path/windows/normalize_glob.ts |  3 ++-
 5 files changed, 53 insertions(+), 6 deletions(-)

diff --git a/_tools/check_docs.ts b/_tools/check_docs.ts
index c675cc8b1..f104275e8 100644
--- a/_tools/check_docs.ts
+++ b/_tools/check_docs.ts
@@ -19,6 +19,7 @@ import {
   type DocNodeModuleDoc,
   type JsDoc,
   type JsDocTagDocRequired,
+  type JsDocTagParam,
   type Location,
   type TsTypeDef,
 } from "@deno/doc";
@@ -182,6 +183,36 @@ function assertHasReturnTag(document: { jsDoc: JsDoc; location: Location }) {
   }
 }
 
+/**
+ * Asserts that a @param tag has a corresponding function definition.
+ */
+function assertHasParamDefinition(
+  document: DocNodeWithJsDoc<DocNodeFunction | ClassMethodDef>,
+  param: JsDocTagParam,
+) {
+  const paramDoc = document.functionDef.params.find((paramDoc) => {
+    if (paramDoc.kind === "identifier") {
+      return paramDoc.name === param.name;
+    } else if (paramDoc.kind === "rest" && paramDoc.arg.kind === "identifier") {
+      return paramDoc.arg.name === param.name;
+    } else if (
+      paramDoc.kind === "assign" && paramDoc.left.kind === "identifier"
+    ) {
+      return paramDoc.left.name === param.name;
+    }
+    return false;
+  });
+
+  if (!paramDoc) {
+    diagnostics.push(
+      new DocumentError(
+        `@param ${param.name} must have a corresponding named function parameter definition.`,
+        document,
+      ),
+    );
+  }
+}
+
 function assertHasParamTag(
   document: { jsDoc: JsDoc; location: Location },
   param: string,
@@ -295,6 +326,7 @@ function assertHasTypeParamTags(
  * Asserts that a function document has:
  * - A `@typeParam` tag for each type parameter.
  * - A {@linkcode https://jsdoc.app/tags-param | @param} tag for each parameter.
+ * - A parameter definition inside the function for each @param tag.
  * - A {@linkcode https://jsdoc.app/tags-returns | @returns} tag.
  * - At least one {@linkcode https://jsdoc.app/tags-example | @example} tag with
  *   a code snippet that executes successfully.
@@ -314,6 +346,17 @@ function assertFunctionDocs(
       assertHasParamTag(document, param.left.name);
     }
   }
+
+  const documentedParams = document.jsDoc.tags?.filter((
+    tag,
+  ): tag is JsDocTagParam =>
+    // Filter nested definitions like options.root as it is still documenting options parameter
+    tag.kind === "param" && !tag.name.includes(".")
+  ) ?? [];
+  for (const param of documentedParams) {
+    assertHasParamDefinition(document, param);
+  }
+
   for (const typeParam of document.functionDef.typeParams) {
     assertHasTypeParamTags(document, typeParam.name);
   }
diff --git a/path/posix/join_globs.ts b/path/posix/join_globs.ts
index 3eaa2706b..08fc39e7d 100644
--- a/path/posix/join_globs.ts
+++ b/path/posix/join_globs.ts
@@ -26,8 +26,9 @@ export type { GlobOptions };
  */
 export function joinGlobs(
   globs: string[],
-  { extended = true, globstar = false }: GlobOptions = {},
+  options: Pick<GlobOptions, "globstar"> = {},
 ): string {
+  const { globstar = false } = options;
   if (!globstar || globs.length === 0) {
     return join(...globs);
   }
@@ -40,5 +41,5 @@ export function joinGlobs(
     }
   }
   if (!joined) return ".";
-  return normalizeGlob(joined, { extended, globstar });
+  return normalizeGlob(joined, { globstar });
 }
diff --git a/path/posix/normalize_glob.ts b/path/posix/normalize_glob.ts
index 296dd0c4e..4a049fac9 100644
--- a/path/posix/normalize_glob.ts
+++ b/path/posix/normalize_glob.ts
@@ -25,8 +25,9 @@ export type { GlobOptions };
  */
 export function normalizeGlob(
   glob: string,
-  { globstar = false }: GlobOptions = {},
+  options: Pick<GlobOptions, "globstar"> = {},
 ): string {
+  const { globstar = false }: GlobOptions = options;
   if (glob.match(/\0/g)) {
     throw new Error(`Glob contains invalid characters: "${glob}"`);
   }
diff --git a/path/windows/join_globs.ts b/path/windows/join_globs.ts
index aca417c92..1b02854d5 100644
--- a/path/windows/join_globs.ts
+++ b/path/windows/join_globs.ts
@@ -27,8 +27,9 @@ export type { GlobOptions };
  */
 export function joinGlobs(
   globs: string[],
-  { extended = true, globstar = false }: GlobOptions = {},
+  options: Pick<GlobOptions, "globstar"> = {},
 ): string {
+  const { globstar = false } = options;
   if (!globstar || globs.length === 0) {
     return join(...globs);
   }
@@ -41,5 +42,5 @@ export function joinGlobs(
     }
   }
   if (!joined) return ".";
-  return normalizeGlob(joined, { extended, globstar });
+  return normalizeGlob(joined, { globstar });
 }
diff --git a/path/windows/normalize_glob.ts b/path/windows/normalize_glob.ts
index ad08e13c2..263bf51c2 100644
--- a/path/windows/normalize_glob.ts
+++ b/path/windows/normalize_glob.ts
@@ -25,8 +25,9 @@ export type { GlobOptions };
  */
 export function normalizeGlob(
   glob: string,
-  { globstar = false }: GlobOptions = {},
+  options: Pick<GlobOptions, "globstar"> = {},
 ): string {
+  const { globstar = false }: GlobOptions = options;
   if (glob.match(/\0/g)) {
     throw new Error(`Glob contains invalid characters: "${glob}"`);
   }