You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 6ca2886
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: apps/docs/src/content/getting-started/overlay.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,7 +107,7 @@ The floating button follows the path the overlay connected to. If that path is `
107
107
108
108
### One overlay per page
109
109
110
-
Only one overlay runs on a page. Importing `@pangular-inspector/devtools/overlay`already starts one on the default URLs. When you call `initOverlay`, it stops the running overlay first, the auto-started one included, and then starts yours. The page never ends up with two connections.
110
+
Only one overlay runs on a page. Importing `@pangular-inspector/devtools/overlay` starts one on the default URLs, on the next task after the import. If `initOverlay` runs before that task, only that overlay starts. The [Vite plugin](./vite.md) does this. If you call `initOverlay` later, it stops the running overlay first, the auto-started one included. Then it starts yours. The page never ends up with two connections.
111
111
112
112
An overlay that was stopped or replaced before it connected does not report its connection error.
|`Agent ran <tool>`| info |`agent`| An [action tool](../agents/tools.md#action-tools)that changes the app or the server finishes, such as `set-http-rule`|
153
-
| The NG error, such as `NG01203: ...`| error |`runtime`| A page reports a forms setup error (`NG01xxx`) |
154
-
|`Navigation failed (NG04002): ...`| error |`runtime`| A page reports a failed navigation |
155
-
|`Hydration mismatch at <app-cart>`| error |`hydration`| A page reports a node that failed to hydrate, with the expected and actual node |
156
-
| The hydration message, such as `NG0505: ...`| warn |`hydration`| A page logs an `NG05xx` hydration message |
|`Agent ran <tool>`| info |`agent`| An [action tool](../agents/tools.md#action-tools) changes the app or the server, such as `set-http-rule`|
153
+
| The NG error, such as `NG01203: ...`| error |`runtime`| A page reports a forms setup error (`NG01xxx`) |
154
+
|`Navigation failed (NG04002): ...`| error |`runtime`| A page reports a failed navigation |
155
+
|`Hydration mismatch at <app-cart>`| error |`hydration`| A page reports a node that failed to hydrate, with the expected and actual node |
156
+
| The hydration message, such as `NG0505: ...`| warn |`hydration`| A page logs an `NG05xx` hydration message |
157
157
158
-
Each message names the pages it came from (also as `page:<pageId>` labels) and has an **Open in Pangular** action that opens the dock that shows it. An error opens a toast the first time it shows up. When the same item comes back, from the same page after a reload or from another tab, the first message counts it (`(3 times)`) instead of posting it again. A call that only reads, like `change-detection` without `record`, posts nothing. Text in messages is masked like the rest of the panel. An agent message shows the first line of the tool's answer and the `page` argument, not the other arguments.
158
+
Each message names the pages it came from (also as `page:<pageId>` labels) and has an **Open in Pangular** action that opens the dock that shows it. An error opens a toast the first time it shows up. When the same item comes back, from the same page after a reload or from another tab, the first message counts it (`(3 times)`) instead of posting it again. A call that only reads, like `change-detection` without `record`, posts nothing, and neither does a call that changed nothing: no page to act on, a refusal from the page or the config, or an argument to fix, such as `navigate` answering `No router state has been reported`. Text in messages is masked like the rest of the panel. An agent message shows the first line of the tool's answer that says what happened, past the untrusted-data notice, and the `page` argument, not the other arguments.
159
159
160
-
A dock shows how many items it has that you have not seen yet: NgRx writes on **NgRx**, Analog writes on **Analog**, and everything else on **Angular**. The **Pangular** group shows the total. The badge is red while one of them is an error or a warning. Opening a dock clears its count, and opening **All tools** clears every count. The count is also part of the dock name that screen readers and the tooltip use, for example `Angular (2 new, with errors)`. When the unseen items hold warnings, such as an NG05xx hydration message, but no error, the name ends in `with warnings` instead.
160
+
A dock shows how many items it has that you have not seen yet: NgRx writes on **NgRx**, Analog writes on **Analog**, and everything else on **Angular**. The **Pangular** group shows the total. The badge is red while one of them is an error or a warning. Opening a dock clears its count, and opening **All tools** clears every count. The tools sidebar of the open group shows the same counts, in the same colours. The count is also part of the dock name that screen readers and the tooltip use, for example `Angular (2 new, with errors)`. When the unseen items hold warnings, such as an NG05xx hydration message, but no error, the name ends in `with warnings` instead.
161
161
162
162
Messages follow the config. An inspector that is off posts nothing (forms errors need `inspectors.forms`, failed navigations `inspectors.router`, hydration messages `inspectors.http`), and an agent tool turned off with `agent.tools`, `agent.readOnly` or `actions` posts nothing either. See [Configuration](./configuration.md).
Copy file name to clipboardExpand all lines: apps/docs/src/content/getting-started/vite.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ export default defineConfig({
42
42
43
43
### The overlay loads itself
44
44
45
-
The plugin adds a module script to every HTML page the dev server transforms, at the end of `<body>`. The script imports `@pangular-inspector/devtools/overlay`, which starts the overlay and the floating button. `vite build` skips the plugin, so the overlay stays out of your production bundle. See [Load the overlay yourself](#load-the-overlay-yourself) to turn it off.
45
+
The plugin adds a module script to every HTML page the dev server transforms, at the end of `<body>`. The script imports `@pangular-inspector/devtools/overlay`, which adds the floating button, and starts the overlay with the hub's path (`/__devframes/pangular/` by default), so the overlay connects there without trying the other default paths first. `vite build` skips the plugin, so the overlay stays out of your production bundle. See [Load the overlay yourself](#load-the-overlay-yourself) to turn it off.
46
46
47
47
### Where to find it
48
48
@@ -64,7 +64,7 @@ The plugin applies to `vite serve` only. `vite build` is not affected, so nothin
64
64
65
65
It adds the overlay to the HTML that Vite transforms, including the template an Analog SSR render starts from. It works under a Vite `base`. A page whose HTML already imports `@pangular-inspector/devtools/overlay` gets no second script.
66
66
67
-
An app that still imports the overlay in `main.ts` gets one overlay, not two: Vite resolves both imports to the same module, which runs once.
67
+
An app that still imports the overlay in `main.ts` gets one overlay, not two: Vite resolves both imports to the same module, and starting the overlay with the hub's path replaces any overlay that is already running.
Copy file name to clipboardExpand all lines: apps/docs/src/content/inspectors/components.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -182,7 +182,7 @@ The server launches the editor on the machine it runs on. It picks the editor in
182
182
| An editor already running | VS Code, Cursor, WebStorm and other IDEs |
183
183
|`VISUAL`, then `EDITOR`|`EDITOR=vim`|
184
184
185
-
If the host installs the `@devframes/service-open` service, its `editor` option takes over.
185
+
If the host installs the `@devframes/service-open` service (the Messages devframe in the hub brings it in), the server tries it first so its `editor` option applies. That service only opens files under the workspace root, so when it refuses a file, such as one in a served app outside the workspace, the server opens it the way the table above describes.
186
186
187
187
The server only opens regular files inside the project. Paths outside the workspace root and the served app, symlinks that point outside them, folders and missing files are refused, and the button says why. See [Open in editor](../security.md#open-in-editor).
Copy file name to clipboardExpand all lines: apps/docs/src/content/security.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -165,6 +165,7 @@ The panel and the overlay can ask the server to open a source file in your edito
165
165
- It resolves the path against the workspace root, the directory the server runs in and the served app. A path that leaves all of them, with `..` or as an absolute path, is refused.
166
166
- It follows symlinks and refuses the file when its real path is outside those directories.
167
167
- It opens regular files only. Folders and missing files are refused.
168
+
- Only a path that passed these checks reaches a launcher: the `@devframes/service-open` service when the host has it, and devframe's `launch-editor` when the service is missing or refuses the path.
168
169
- Line and column must be positive whole numbers, or they are left out.
169
170
170
171
The request names a file and a line, never a command. The editor comes from the server's environment. Agent tools can't open files.
0 commit comments