Skip to content

Commit 61afe0f

Browse files
committed
docs(release): warn that legacy-peer-deps skips every peer check
1 parent 095e630 commit 61afe0f

2 files changed

Lines changed: 2 additions & 2 deletions

File tree

‎apps/docs/src/content/getting-started/installation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ declare module '@pangular-inspector/devtools/overlay';
8484

8585
### Tested versions
8686

87-
The Vite plugin needs Vite 6 or later (`vite` `>=6`). An app on Vite 5 can still use the Express hub or the CLI, but npm checks the optional `vite` peer against the installed Vite and stops with `ERESOLVE`. Add `legacy-peer-deps=true` to the project's `.npmrc` and commit it, then install as below; `npm ci` needs the same setting. pnpm only prints a warning. The peer range is `@angular/core` and `@angular/common` `>=12.2.0 <23.0.0`. The overlay reads Angular's private debug APIs, so each new major is tested before the range takes it in. CI tests these versions:
87+
The Vite plugin needs Vite 6 or later (`vite` `>=6`). An app on Vite 5 can still use the Express hub or the CLI, but npm checks the optional `vite` peer against the installed Vite and stops with `ERESOLVE`. Upgrading to Vite 6 is the clean fix. Otherwise add `legacy-peer-deps=true` to the project's `.npmrc` and commit it, then install as below; `npm ci` needs the same setting. That setting makes npm skip every peer check in the project, not just this one, so a missing or mismatched peer of another package goes unreported. pnpm only prints a warning. The peer range is `@angular/core` and `@angular/common` `>=12.2.0 <23.0.0`. The overlay reads Angular's private debug APIs, so each new major is tested before the range takes it in. CI tests these versions:
8888

8989
| Angular | Node.js | What runs | When |
9090
| ----------------------- | ------- | ------------------------------------------------------------------------- | ------------------------------------- |

‎packages/devtools/CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Most setups need changes when they come from 0.0.7, so read **Upgrading from 0.0
1010

1111
These changes can break a 0.0.7 setup without an error.
1212

13-
- **The Vite plugin needs Vite 6 or later.** The `vite` peer range is `>=6`, the versions its tests run against. Vite 5 apps can use the Express hub or the standalone CLI instead. npm still checks the optional peer against an installed Vite 5 and stops with `ERESOLVE`, so add `legacy-peer-deps=true` to the project's `.npmrc` (which `npm ci` needs too) before `npm install -D @pangular-inspector/devtools`. pnpm only warns.
13+
- **The Vite plugin needs Vite 6 or later.** The `vite` peer range is `>=6`, the versions its tests run against. Vite 5 apps can use the Express hub or the standalone CLI instead. npm still checks the optional peer against an installed Vite 5 and stops with `ERESOLVE`, so upgrade to Vite 6, or add `legacy-peer-deps=true` to the project's `.npmrc` (which `npm ci` needs too, and which turns off every peer check in the project) before `npm install -D @pangular-inspector/devtools`. pnpm only warns.
1414
- **The Vite plugin asks for the one-time code, and its MCP endpoint asks for a bearer token, by default.** In 0.0.7 the code was on only when a non-loopback host or origin was allowed. An MCP client set up against `http://localhost:5173/__devframes/__mcp` gets `401`. Send the token (see "Send a token" in the MCP server docs, or run `pangular mcp --print-config`), or pass `auth: false` on a machine only you use.
1515
- **The Express hub is off in production:** when `NODE_ENV` is `production`, or when the server is a production Angular build (`ngDevMode` is `false`). `nodeMiddleware` and `ssrMiddleware` then only call `next()`, and `/__devframes/` answers `404`. To keep the devtools on a staging server, pass `enabled: true` to `initPangularHub()`. Check `devtools.enabled` before the `app.use()` calls to skip them.
1616
- **The Express hub answers this machine only.** It refuses requests from other addresses and requests to a non-loopback `Host` with `403`. To reach it from a phone or another machine, pass `allowLan: true` and list the device's origin in `allowedOrigins`. `allowLan` needs the one-time code on.

0 commit comments

Comments
 (0)