Skip to content

fix(cli): accept evlog 2.31 as a peer so the CLI installs on 2.x projects - #920

Merged
HugoRCD merged 2 commits into
v3from
EVL-705/widen-cli-peer-range
Oct 21, 2026
Merged

HugoRCD merged 2 commits into
v3from
EVL-705/widen-cli-peer-range

Conversation

@evlogai

@evlogai evlogai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Refs EVL-705. The evlog upgrade acceptance criterion stays open until #870 lands on v3, so this PR does not close the issue on merge.

What changed

  • packages/cli/package.json: the evlog peer goes from >=3.0.0-beta.0 to ^2.31.0 || >=3.0.0-beta.0. The peer stays required, since it was never optional.
  • A patch changeset for @evlog/cli.
  • A CI step in the Test job, CLI installs next to evlog 2.x, that packs the CLI and installs it into a fresh npm project on evlog@2.31.0 and evlog@2.33.1 with no --legacy-peer-deps, then runs evlog doctor --json. It runs only when packages/cli changes on a pull request.

Why 2.31.0 is the minimum

The CLI changelog (0.10.0) already says the CLI needs evlog 2.31.0 or later, and main has carried that peer since then. I checked the commands that do not need a framework against 2.31.0 and 2.33.1: --version, doctor, config. map exits 1 on a bare fixture because no framework is detected, which is the expected result, not a load failure. Lower 2.x versions are not tested, so the range does not claim them.

Before and after

Before (unmodified peer range, npm 11, evlog@2.33.1 already installed):

npm i -D /path/to/evlog-cli-1.0.0-beta.0.tgz
npm error code ERESOLVE
npm error ERESOLVE unable to resolve dependency tree
  peer evlog@">=3.0.0-beta.0" from @evlog/cli@1.0.0-beta.0

After (packed CLI from this branch, same project shape):

npm install evlog@2.31.0            -> exit 0
npm install --save-dev <cli>.tgz    -> exit 0 (added 13 packages)
./node_modules/.bin/evlog doctor    -> exit 0

The same four steps pass on evlog@2.33.1, with npm and with pnpm. pnpm also passes with strict-peer-dependencies=true.

Verification

  • Ran locally: install and doctor on 2.31.0 and 2.33.1, npm and pnpm; pnpm strict on 2.31.0; pnpm run lint, pnpm run typecheck, and pnpm run test in packages/cli (34 files, 707 tests). Node 24.21.0 in the sandbox.
  • The new CI step runs the same commands on the PR. It has not run on GitHub yet.
  • The failing-first commit is 2662c99, the CI step alone. It fails on the old range with the ERESOLVE above, then cca25e8 widens the range.

Not verified here

  • evlog upgrade on a 2.x fixture is not covered. The upgrade command is not on v3 yet; it lands with feat(cli): scaffold evlog upgrade with the v2 to v3 transform table #870. Once it does, the CI step should also run evlog upgrade --dry-run on the 2.x fixture.
  • The changeset's version bump keeps this range. .changeset/config.json already sets onlyUpdatePeerDependentsWhenOutOfRange: true, and ^2.31.0 || >=3.0.0-beta.0 already contains 3.0.0-beta.0, so changesets should leave it alone. I have not run changeset version to prove it. chore(repo): version packages (beta) #878 needs a check after it regenerates.
  • Not checked: the @evlog/telemetry EBADENGINE warning on Node 20 from the earlier report. The CLI's engines field is >=22, so this PR does not touch it.
ELI5

The command-line helper for evlog only let itself be installed next to evlog 3 betas. Projects still on evlog 2 got an install error. This change lets the helper sit next to evlog 2.31 and later, and a new automated check installs it next to two versions of evlog 2 to make sure that keeps working.

@evlogai
evlogai Bot requested a review from HugoRCD October 21, 2026 07:27
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
evi Ready Ready Preview Oct 21, 2026 7:29am UTC
evlog-docs Ready Ready Preview, v0 Oct 21, 2026 7:29am UTC
evlog-render-lab Ready Ready Preview Oct 21, 2026 7:29am UTC
evlog-telemetry Ready Ready Preview Oct 21, 2026 7:29am UTC
just-use-evlog Ready Ready Preview Oct 21, 2026 7:29am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 89d86d6d-293b-4091-b1fc-bb826b36570f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for following the naming conventions! 🙏

@pkg-pr-new

pkg-pr-new Bot commented Oct 21, 2026

Copy link
Copy Markdown
@evlog/cli

npm i https://pkg.pr.new/@evlog/cli@920

evlog

npm i https://pkg.pr.new/evlog@920

@evlog/nuxthub

npm i https://pkg.pr.new/@evlog/nuxthub@920

@evlog/signals

npm i https://pkg.pr.new/@evlog/signals@920

@evlog/telemetry

npm i https://pkg.pr.new/@evlog/telemetry@920

commit: cca25e8

@HugoRCD
HugoRCD merged commit 4324afd into v3 Oct 21, 2026
22 checks passed
@HugoRCD
HugoRCD deleted the EVL-705/widen-cli-peer-range branch October 21, 2026 20:32

This branch was successfully deployed

5 active deployments
Preview – evi — cca25e87 Deployed Oct 21, 2026 by vercel[bot]
Preview – evlog-telemetry — cca25e87 Deployed Oct 21, 2026 by vercel[bot]
Preview – evlog-docs — cca25e87 Deployed Oct 21, 2026 by vercel[bot]
Preview – just-use-evlog — cca25e87 Deployed Oct 21, 2026 by vercel[bot]
Preview – evlog-render-lab — cca25e87 Deployed Oct 21, 2026 by vercel[bot]
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.

1 participant