@ng-annotate/vite-plugin 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -9
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,20 +1,16 @@
|
|
|
1
1
|
# @ng-annotate/vite-plugin
|
|
2
2
|
|
|
3
|
-
Vite plugin for [ng-annotate-mcp](https://github.com/yngvebn/ngagentify) — a dev-only
|
|
3
|
+
Vite plugin for [ng-annotate-mcp](https://github.com/yngvebn/ngagentify) — a dev-only toolchain addon that lets you annotate components in the browser and have an AI agent act on those annotations in real time.
|
|
4
|
+
|
|
5
|
+
> **Angular CLI users:** you don't need this package. `@ng-annotate/angular` ships its own custom `dev-server` builder that handles everything. This plugin is for other Vite-based projects (Vue, Svelte, plain Vite, etc.).
|
|
4
6
|
|
|
5
7
|
## What this plugin does
|
|
6
8
|
|
|
7
|
-
- Injects a WebSocket handler at `/__annotate` that the
|
|
9
|
+
- Injects a WebSocket handler at `/__annotate` that the overlay uses to send annotations to the store
|
|
8
10
|
- Injects `window.__NG_ANNOTATE_MANIFEST__` into the served HTML — a map of component selectors to their source file paths, enabling the AI agent to find the right file to edit
|
|
9
11
|
|
|
10
12
|
## Install
|
|
11
13
|
|
|
12
|
-
```bash
|
|
13
|
-
ng add @ng-annotate/angular
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
The schematic configures the plugin automatically. For manual setup:
|
|
17
|
-
|
|
18
14
|
```bash
|
|
19
15
|
npm install @ng-annotate/vite-plugin --save-dev
|
|
20
16
|
```
|
|
@@ -33,7 +29,7 @@ export default defineConfig({
|
|
|
33
29
|
|
|
34
30
|
| Package | Purpose |
|
|
35
31
|
|---|---|
|
|
36
|
-
| [`@ng-annotate/angular`](https://www.npmjs.com/package/@ng-annotate/angular) | Angular library (overlay UI, `provideNgAnnotate()
|
|
32
|
+
| [`@ng-annotate/angular`](https://www.npmjs.com/package/@ng-annotate/angular) | Angular library (overlay UI, `provideNgAnnotate()`, custom dev-server builder) |
|
|
37
33
|
| [`@ng-annotate/mcp-server`](https://www.npmjs.com/package/@ng-annotate/mcp-server) | MCP server exposing tools to the AI agent |
|
|
38
34
|
|
|
39
35
|
## License
|
package/package.json
CHANGED