WordPress/gutenberg

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

Open

#39810 opened on Mar 28, 2022

View on GitHub
 (1 comment) (1 reaction) (1 assignee)JavaScript (9,607 stars) (3,893 forks)batch import
Good First IssueNeeds Dev[Status] In Progress[Tool] ESLint plugin[Type] Code Quality

Description

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.

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Understanding of npm/yarn/pnpm dependency resolutionFamiliarity with eslint shareable configs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine the package.json of @wordpress/eslint plugin to identify which dependencies need to be moved to peerDependencies. Consult the ESLint documentation on shareable configs for recommended version ranges (preferably >=). Check the current dependency versions and decide appropriate peer ranges. Consider the impact on consumers using yarn PnP or pnpm with strict hoisting. Reference: https://eslint.org/docs/developer guide/shareable configs#publishing a shareable config.