@ng-annotate/vite-plugin 0.2.4 → 0.2.6

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.
Files changed (2) hide show
  1. package/README.md +41 -0
  2. package/package.json +13 -2
package/README.md ADDED
@@ -0,0 +1,41 @@
1
+ # @ng-annotate/vite-plugin
2
+
3
+ Vite plugin for [ng-annotate-mcp](https://github.com/yngvebn/ngagentify) — a dev-only Angular toolchain addon that lets you annotate components in the browser and have an AI agent act on those annotations in real time.
4
+
5
+ ## What this plugin does
6
+
7
+ - Injects a WebSocket handler at `/__annotate` that the Angular overlay uses to send annotations to the store
8
+ - 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
+
10
+ ## Install
11
+
12
+ ```bash
13
+ ng add @ng-annotate/angular
14
+ ```
15
+
16
+ The schematic configures the plugin automatically. For manual setup:
17
+
18
+ ```bash
19
+ npm install @ng-annotate/vite-plugin --save-dev
20
+ ```
21
+
22
+ ```ts
23
+ // vite.config.ts
24
+ import { defineConfig } from 'vite';
25
+ import { ngAnnotateMcp } from '@ng-annotate/vite-plugin';
26
+
27
+ export default defineConfig({
28
+ plugins: [...ngAnnotateMcp()],
29
+ });
30
+ ```
31
+
32
+ ## Related packages
33
+
34
+ | Package | Purpose |
35
+ |---|---|
36
+ | [`@ng-annotate/angular`](https://www.npmjs.com/package/@ng-annotate/angular) | Angular library (overlay UI, `provideNgAnnotate()`) |
37
+ | [`@ng-annotate/mcp-server`](https://www.npmjs.com/package/@ng-annotate/mcp-server) | MCP server exposing tools to the AI agent |
38
+
39
+ ## License
40
+
41
+ MIT
package/package.json CHANGED
@@ -1,13 +1,24 @@
1
1
  {
2
2
  "name": "@ng-annotate/vite-plugin",
3
- "version": "0.2.4",
3
+ "version": "0.2.6",
4
4
  "type": "module",
5
+ "description": "Vite plugin for ng-annotate-mcp — WebSocket annotation bridge and component manifest for Angular dev tooling",
6
+ "keywords": [
7
+ "angular",
8
+ "vite",
9
+ "vite-plugin",
10
+ "mcp",
11
+ "ai",
12
+ "devtools",
13
+ "ng-annotate"
14
+ ],
5
15
  "repository": {
6
16
  "type": "git",
7
17
  "url": "https://github.com/yngvebn/ngagentify"
8
18
  },
9
19
  "files": [
10
- "dist"
20
+ "dist",
21
+ "README.md"
11
22
  ],
12
23
  "main": "dist/index.js",
13
24
  "types": "dist/index.d.ts",