WordPress/gutenberg

@wordpress/eslint-plugin dependencies on other eslint plugins should be peer dependencies

Open

#39.810 aperta il 28 mar 2022

Vedi su GitHub
 (1 commento) (1 reazione) (1 assegnatario)JavaScript (3893 fork)batch import
Good First IssueNeeds Dev[Status] In Progress[Tool] ESLint plugin[Type] Code Quality

Metriche repository

Star
 (9607 star)
Metriche merge PR
 (Merge medio 18g 1h) (406 PR mergiate in 30 g)

Descrizione

What problem does this address?

Having these other plugins as dependencies of @wordpress/eslint-plugin only works due to npm/yarn/pnpm "hoisting" dependencies. If this hoisting does not happen (e.g. with yarn's PnP or pnpm configured to disable the default compatibility hoisting that's intended to support broken dependencies like this), eslint does not find the depended plugins.

If a package such as @rushstack/eslint-patch is used to improve eslint's plugin loading, we can easily run into the opposite problem: if plugins used by @wordpress/eslint-plugin are also used directly, we can easily wind up with a version conflict (for example, if the local config uses eslint-plugin-prettier 4.0.0 while @wordpress/eslint-plugin is still depending on ^3.3.0).

What is your proposed solution?

Change these dependencies into peer dependencies with appropriate ranges (preferably >= rather than ^), as recommended by Eslint for sharable configs.

Guida contributor