chore(docs): updated JSDocs

packages/cli/src/core/diffEnv.ts

@@ -4,10 +4,8 @@
 export type DiffResult = {
   /** Keys present in the example file but missing from the current file */
   missing: string[];
-
   /** Keys present in the current file but not defined in the example file */
   extra: string[];
-
   /** Keys that exist in both files but have mismatched values */
   valueMismatches: {
     /** The environment variable key */

packages/cli/src/core/envLine.ts

@@ -2,10 +2,13 @@
  * This module provides utility functions for parsing and handling dotenv files.
  */
 export interface EnvKeyValue {
+  /** The key of the environment variable. */
   key: string;
+  /** The value of the environment variable. */
   value: string;
 }
 
+/** BOM (Byte Order Mark) character used to indicate UTF-8 encoding. */
 const BOM = '\uFEFF';
 
 /** Strips a UTF-8 BOM from the start of the content, if present.

packages/cli/src/core/suggestTypos.ts

@@ -2,6 +2,16 @@ import type { TypoSuggestion } from '../config/types.js';
 import { MAX_TYPO_DISTANCE, MAX_TYPO_RATIO } from '../config/constants.js';
 import { levenshtein } from './helpers/levenshtein.js';
 
+/**
+ * A candidate key that qualifies as a likely typo of a reported key
+ */
+interface ClosestMatch {
+  /** The candidate key from the existing key pool */
+  key: string;
+  /** Levenshtein distance between the reported key and this candidate */
+  distance: number;
+}
+
 /**
  * Cross-references reported keys against a pool of existing candidate keys and
  * suggests the closest match when a key looks like a simple typo of another.
@@ -50,8 +60,8 @@ export function suggestTypos(
 function findClosestKey(
   key: string,
   candidateKeys: string[],
-): { key: string; distance: number } | null {
-  let best: { key: string; distance: number } | null = null;
+): ClosestMatch | null {
+  let best: ClosestMatch | null = null;
 
   for (const candidate of candidateKeys) {
     if (candidate === key) continue;