WordPress/gutenberg

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

Open

#39,810 建立於 2022年3月28日

在 GitHub 查看
 (1 留言) (1 反應) (1 負責人)JavaScript (9,607 star) (3,893 fork)batch import
Good First IssueNeeds Dev[Status] In Progress[Tool] ESLint plugin[Type] Code Quality

描述

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.

貢獻者指南

技術棧
javascriptnodejs
領域
developer experiencetooling
議題類型
refactor
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Understanding of npm/yarn/pnpm dependency resolutionFamiliarity with eslint shareable configs
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
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.