Skip to content

Remove eslint-plugin-jsdoc from eslint-plugin-cli#7182

Merged
ryancbahan merged 1 commit intomainfrom
04-02-remove-eslint-plugin-jsdoc
Apr 3, 2026
Merged

Remove eslint-plugin-jsdoc from eslint-plugin-cli#7182
ryancbahan merged 1 commit intomainfrom
04-02-remove-eslint-plugin-jsdoc

Conversation

@ryancbahan
Copy link
Copy Markdown
Contributor

@ryancbahan ryancbahan commented Apr 3, 2026

Summary

  • Remove eslint-plugin-jsdoc from eslint-plugin-cli package (dependency, require, plugin registration, and the single rule)
  • Move the dependency to root package.json and register the plugin in eslint.config.js where the comprehensive jsdoc rule set is actually configured
  • The jsdoc/require-returns-description rule from eslint-plugin-cli/config.js was redundant with the root config's full jsdoc rule set

@ryancbahan ryancbahan force-pushed the 04-02-remove-eslint-plugin-jsdoc branch from 6d3c259 to f443bd0 Compare April 3, 2026 01:16
@ryancbahan ryancbahan force-pushed the 04-02-remove-tempy branch from 85b975c to bfd7342 Compare April 3, 2026 01:16
@ryancbahan ryancbahan marked this pull request as ready for review April 3, 2026 01:17
@ryancbahan ryancbahan requested a review from a team as a code owner April 3, 2026 01:17
Move the jsdoc plugin dependency and registration from eslint-plugin-cli
to the root eslint.config.js where the jsdoc rules are actually
configured. The single jsdoc/require-returns-description rule that was
in eslint-plugin-cli's config.js is redundant with the comprehensive
jsdoc rule set in the root config, so it's removed.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ryancbahan ryancbahan force-pushed the 04-02-remove-tempy branch from bfd7342 to 73a9304 Compare April 3, 2026 01:23
@ryancbahan ryancbahan force-pushed the 04-02-remove-eslint-plugin-jsdoc branch from f443bd0 to 9941d53 Compare April 3, 2026 01:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

packages/cli-kit/dist/private/node/temp-dir.d.ts
export declare const systemTempDir: string;

Existing type declarations

packages/cli-kit/dist/public/node/path.d.ts
 import type { URL } from 'url';
 /**
  * Joins a list of paths together.
  *
  * @param paths - Paths to join.
  * @returns Joined path.
  */
 export declare function joinPath(...paths: string[]): string;
 /**
  * Normalizes a path.
  *
  * @param path - Path to normalize.
  * @returns Normalized path.
  */
 export declare function normalizePath(path: string): string;
 /**
  * Resolves a list of paths together.
  *
  * @param paths - Paths to resolve.
  * @returns Resolved path.
  */
 export declare function resolvePath(...paths: string[]): string;
 /**
  * Returns the relative path from one path to another.
  *
  * @param from - Path to resolve from.
  * @param to - Path to resolve to.
  * @returns Relative path.
  */
 export declare function relativePath(from: string, to: string): string;
 /**
  * Returns whether the path is absolute.
  *
  * @param path - Path to check.
  * @returns Whether the path is absolute.
  */
 export declare function isAbsolutePath(path: string): boolean;
 /**
  * Returns the directory name of a path.
  *
  * @param path - Path to get the directory name of.
  * @returns Directory name.
  */
 export declare function dirname(path: string): string;
 /**
  * Returns the base name of a path.
  *
  * @param path - Path to get the base name of.
  * @param ext - Optional extension to remove from the result.
  * @returns Base name.
  */
 export declare function basename(path: string, ext?: string): string;
 /**
  * Returns the extension of the path.
  *
  * @param path - Path to get the extension of.
  * @returns Extension.
  */
 export declare function extname(path: string): string;
 /**
  * Parses a path into its components (root, dir, base, ext, name).
  *
  * @param path - Path to parse.
  * @returns Parsed path object.
  */
 export declare function parsePath(path: string): {
     root: string;
     dir: string;
     base: string;
     ext: string;
     name: string;
 };
 /**
+ * Returns the longest common parent directory of two absolute paths.
+ *
+ * @param first - First absolute path.
+ * @param second - Second absolute path.
+ * @returns The common parent directory, or '/' if they share only the root.
+ */
+export declare function commonParentDirectory(first: string, second: string): string;
+/**
  * Given an absolute filesystem path, it makes it relative to
  * the current working directory. This is useful when logging paths
  * to allow the users to click on the file and let the OS open it
  * in the editor of choice.
  *
  * @param path - Path to relativize.
  * @param dir - Current working directory.
  * @returns Relativized path.
  */
 export declare function relativizePath(path: string, dir?: string): string;
 /**
  * Given 2 paths, it returns whether the second path is a subpath of the first path.
  *
  * @param mainPath - The main path.
  * @param subpath - The subpath.
  * @returns Whether the subpath is a subpath of the main path.
  */
 export declare function isSubpath(mainPath: string, subpath: string): boolean;
 /**
  * Given a module's import.meta.url it returns the directory containing the module.
  *
  * @param moduleURL - The value of import.meta.url in the context of the caller module.
  * @returns The path to the directory containing the caller module.
  */
 export declare function moduleDirectory(moduleURL: string | URL): string;
 /**
  * When running a script using `npm run`, something interesting happens. If the current
  * folder does not have a `package.json` or a `node_modules` folder, npm will traverse
  * the directory tree upwards until it finds one. Then it will run the script and set
  * `process.cwd()` to that folder, while the actual path is stored in the INIT_CWD
  * environment variable (see here: https://docs.npmjs.com/cli/v9/commands/npm-run-script#description).
  *
  * @returns The path to the current working directory.
  */
 export declare function cwd(): string;
 /**
  * Tries to get the value of the `--path` argument, if provided.
  *
  * @param argv - The arguments to search for the `--path` argument.
  * @returns The value of the `--path` argument, if provided.
  */
 export declare function sniffForPath(argv?: string[]): string | undefined;
 /**
  * Returns whether the `--json` or `-j` flags are present in the arguments.
  *
  * @param argv - The arguments to search for the `--json` and `-j` flags.
  * @returns Whether the `--json` or `-j` flag is present in the arguments.
  */
 export declare function sniffForJson(argv?: string[]): boolean;
 /**
  * Removes any `..` traversal segments from a relative path and calls `warn`
  * if any were stripped. Normal `..` that cancel out within the path (e.g.
  * `foo/../bar` → `bar`) are collapsed but never allowed to escape the root.
  * Both `/` and `\` are treated as separators for cross-platform safety.
  *
  * @param input - The relative path to sanitize.
  * @param warn - Called with a human-readable warning when traversal segments are removed.
  * @returns The sanitized path (may be an empty string if all segments were traversal).
  */
 export declare function sanitizeRelativePath(input: string, warn: (msg: string) => void): string;

Copy link
Copy Markdown
Contributor

@dmerand dmerand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks reasonable to me.

I do think it slightly shifts @shopify/eslint-plugin-cli away from being a fully self-contained shared config package and more toward being an internal base config plus custom-rules package, but given that the real JSDoc policy already lives in root eslint.config.js, that direction seems coherent here. Moving eslint-plugin-jsdoc ownership to the root config makes the actual layering a bit clearer.

Base automatically changed from 04-02-remove-tempy to main April 3, 2026 20:21
@ryancbahan ryancbahan added this pull request to the merge queue Apr 3, 2026
Merged via the queue into main with commit 5fcafb5 Apr 3, 2026
37 of 66 checks passed
@ryancbahan ryancbahan deleted the 04-02-remove-eslint-plugin-jsdoc branch April 3, 2026 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants