Lifecycle hooks are hidden from the script list but never run in Yarn 2+ projects
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 72/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- javascript, node.js
調査の方向性
Start with lib/workspace.js and lib/package-managers.js to trace script grouping and package manager detection, then follow their callers in cli.js. Read the existing script and detection tests, and run them before adding coverage for Yarn 2+ signals and hook execution. Done when Yarn 2+ lists hooks separately while Yarn 1 and other managers still group hooks, with the README updated.
索引モデルが issue の本文から書いたものです。
説明
Description
Since #4, the script list attaches pre/post hooks to their main script: build is shown with (+ prebuild, postbuild), and prebuild / postbuild are no longer listed. The README explains why:
Running
buildruns its hooks too, as the package manager normally does.
That is true for npm, pnpm, Bun and Yarn 1. Since version 2, Yarn no longer runs custom pre/post scripts, by design (Yarn migration guide). In a Yarn 2+ project, the CLI therefore:
- announces hooks that don't run:
buildis described as(+ prebuild, postbuild), but onlybuildruns; - hides scripts with no way to reach them:
prebuildandpostbuildare removed from the list, so they can't be run from the CLI at all.
Steps to reproduce
Requires Corepack to be enabled (corepack enable). On Node.js versions that don't bundle it, run npm install --global corepack first.
-
Create a project inside a scratch workspace:
mkdir -p /tmp/dws-repro/berry-hooks cd /tmp/dws-repro/berry-hooks -
Add this
package.json:{ "name": "berry-hooks", "packageManager": "[email protected]", "scripts": { "prebuild": "echo prebuild ran", "build": "echo build ran", "postbuild": "echo postbuild ran" } } -
Install, which creates
yarn.lock, then start the published CLI.DEV_WORKSPACE_CONFIGkeeps your own saved workspace untouched:yarn install DEV_WORKSPACE_CONFIG=/tmp/dws-repro/config.json \ npx -p @modulane/[email protected] dws --workspace /tmp/dws-repro -
Select
berry-hooks, thenbuild.
Actual behaviour
Package manager: yarn (from the packageManager field)
? Select a script
❯ ▶ build
↩ Back to projects
echo build ran (+ prebuild, postbuild)
----------------------------------------
Running: yarn run build
Directory: /tmp/dws-repro/berry-hooks
----------------------------------------
build ran
Command completed successfully.
prebuild and postbuild neither run nor appear in the list. Both still work when run directly, for example with yarn run prebuild.
Expected behaviour
In a Yarn 2+ project, prebuild and postbuild appear as ordinary scripts, and build doesn't claim to run them.
Behaviour by package manager
Running <tool> run build on the same package.json:
| Package manager | Runs prebuild / postbuild |
|---|---|
| npm 10.9.7 | Yes |
| pnpm 9 and 10 | Yes |
| Bun 1.4.4 | Yes |
| Yarn 1.22.22 | Yes |
| Yarn 2.4.2, 3.8.7 and 4.18.1 | No |
Projects that follow Yarn's advice and chain hooks explicitly ("build": "yarn prebuild && …") are partly affected: the chained hooks run, but postbuild is still announced and still hidden.
Cause
groupLifecycleScripts()runs insidegetScripts(), before the package manager is known, so hooks are always grouped.detectPackageManager()reportsyarnfor both Yarn 1 and Yarn 2+.- CI doesn't catch it:
- it installs Yarn 1 through
npm install --global yarn; - the real-script test checks which tool ran a script, not whether hooks ran.
- it installs Yarn 1 through
Suggested fix
-
Tell Yarn 2+ apart from Yarn 1 during detection. Two signals hold for Yarn 2, 3 and 4:
- a
packageManagerfield set toyarn@2or later; - a
yarn.lockthat contains a__metadata:block. Yarn 1 lockfiles never have one.
A
.yarnrc.ymlfile is not a reliable signal on its own: the reproduction above has none. - a
-
Group hooks only when the detected tool runs them. For example, the grouping could move out of
getScripts()to after detection incli.js, orgetScripts()could receive the package manager. -
Add tests:
- detection of Yarn 2+ from both signals;
- a real-script case that checks whether hooks ran, with a Yarn 2+ project in CI.
-
Update the README paragraph to mention that Yarn 2+ lists these hooks separately.
I'd be glad to open a PR for this if the approach suits you.
Environment
@modulane/dev-workspace-cli0.5.0, installed from npm.lib/is identical onmainat dfccb6b.- Node.js 22.22.2, Linux x64
- Yarn 4.18.1 through Corepack 0.34.6, plus Yarn 2.4.2 and 3.8.7 for the comparison table
- 主要言語
- JavaScript
- スター
- 0
- フォーク
- 0
- 平均マージ
- 46分
- マージ済み PR(30日)
- 15
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
似ている issue
-
enhancement javascript python
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
jlab-sensing/ENTS-backend#851 ·
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 86/100
guilhermerodz/input-otp#157 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
davidjerleke/embla-carousel#1414 ·
メンテナーはふだん 4 日以内に返信
-
0. Needs triage bug
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信