@darksheep/eslint 6.4.3 → 6.5.0

package/types/src/utilities/filesystem.d.ts

@@ -1,34 +1,34 @@
 /**
- * @param {string} path The absolute path to the file to check
+ * @param {string} path - The absolute path to the file to check.
  * @returns {Promise<boolean>}
  */
 export function exists(path: string): Promise<boolean>;
 /**
- * Does {filePath} exist in {projectPath}
- * @param {string} [filePath] The path of the file to check
- * @param {string} [projectPath] The path to the project root
+ * Does {filePath} exist in {projectPath}.
+ * @param {string} [filePath] - The path of the file to check.
+ * @param {string} [projectPath] - The path to the project root.
  * @returns {boolean}
  */
 export function descendsFrom(filePath?: string | undefined, projectPath?: string | undefined): boolean;
 /**
- * Create a list of parent directories from {filepath} to {stopDirectory}
- * @param {string} filepath The file to start from
- * @param {string} [stopDirectory] The directory to stop at
+ * Create a list of parent directories from {filepath} to {stopDirectory}.
+ * @param {string} filepath - The file to start from.
+ * @param {string} [stopDirectory] - The directory to stop at.
  * @returns {string[]}
  */
 export function listParents(filepath: string, stopDirectory?: string | undefined): string[];
 /**
- * Find the closest {filename} starting from {rootFilePath}
- * @param {string[]} paths The paths to search in
- * @param {string} filename The filename to find
- * @returns {Promise<string|null>} Returns absolute path to the closest {filename} if found
+ * Find the closest {filename} starting from {rootFilePath}.
+ * @param {string[]} paths - The paths to search in.
+ * @param {string} filename - The filename to find.
+ * @returns {Promise<string|null>} Returns absolute path to the closest {filename} if found.
  */
 export function findInPaths(paths: string[], filename: string): Promise<string | null>;
 /**
- * Find the closest {filename} starting from {rootFilePath}
- * @param {string} rootFilePath The file to start the search from
- * @param {string} filename The filename to find
- * @param {string} [stopDirectory] The directory to stop searching at
- * @returns {Promise<string|null>} Returns absolute path to the closest {filename} if found
+ * Find the closest {filename} starting from {rootFilePath}.
+ * @param {string} rootFilePath - The file to start the search from.
+ * @param {string} filename - The filename to find.
+ * @param {string} [stopDirectory] - The directory to stop searching at.
+ * @returns {Promise<string|null>} Returns absolute path to the closest {filename} if found.
  */
 export function findUp(rootFilePath: string, filename: string, stopDirectory?: string | undefined): Promise<string | null>;

package/types/src/utilities/package.d.ts

@@ -1,7 +1,7 @@
 /**
- * Get the path of the eslint package json
- * @param {import('node:url').URL} rootUrl The root url of the module
- * @param {string} [packageName] The name of the npm package
+ * Get the path of the eslint package json.
+ * @param {import('node:url').URL} rootUrl - The root url of the module.
+ * @param {string} [packageName] - The name of the npm package.
  * @returns {Promise<import('type-fest').PackageJson | null>}
  */
 export function getPackageJson(rootUrl: import("node:url").URL, packageName?: string | undefined): Promise<import("type-fest").PackageJson | null>;