pi-doc-injector 0.1.1 → 0.1.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 +17 -16
- package/docs/bun.md +32 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ pi install npm:pi-doc-injector
|
|
|
13
13
|
### Via git
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
pi install git:github.com/
|
|
16
|
+
pi install git:github.com/lmn451/pi-doc-injector
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
### Manual
|
|
@@ -36,6 +36,7 @@ keywords: [test, testing, jest, vitest]
|
|
|
36
36
|
---
|
|
37
37
|
|
|
38
38
|
# Testing Workflow
|
|
39
|
+
|
|
39
40
|
Your documentation here...
|
|
40
41
|
```
|
|
41
42
|
|
|
@@ -68,12 +69,12 @@ Create `.pi/doc-injector.json` in your project root to customize behavior:
|
|
|
68
69
|
}
|
|
69
70
|
```
|
|
70
71
|
|
|
71
|
-
| Option
|
|
72
|
-
|
|
73
|
-
| `docsPath`
|
|
74
|
-
| `matchThreshold`
|
|
75
|
-
| `contextThreshold` | `80`
|
|
76
|
-
| `recursive`
|
|
72
|
+
| Option | Default | Description |
|
|
73
|
+
| ------------------ | ---------- | -------------------------------------------------------- |
|
|
74
|
+
| `docsPath` | `"./docs"` | Path to docs folder (relative to project root) |
|
|
75
|
+
| `matchThreshold` | `2` | Minimum keyword matches required to inject a doc |
|
|
76
|
+
| `contextThreshold` | `80` | Skip injection when context usage exceeds this % (0–100) |
|
|
77
|
+
| `recursive` | `true` | Scan docs subdirectories recursively |
|
|
77
78
|
|
|
78
79
|
### Keyword Matching
|
|
79
80
|
|
|
@@ -83,15 +84,15 @@ Injection is also skipped if the current context usage exceeds 80% of the token
|
|
|
83
84
|
|
|
84
85
|
## Commands
|
|
85
86
|
|
|
86
|
-
| Command
|
|
87
|
-
|
|
88
|
-
| `/doc-inject on`
|
|
89
|
-
| `/doc-inject off`
|
|
90
|
-
| `/doc-inject toggle` | Toggle doc injection on/off
|
|
91
|
-
| `/doc-inject list`
|
|
92
|
-
| `/doc-inject reset`
|
|
93
|
-
| `/doc-inject status` | Show current injection status and config
|
|
94
|
-
| `/doc-reload`
|
|
87
|
+
| Command | Description |
|
|
88
|
+
| -------------------- | ---------------------------------------------------- |
|
|
89
|
+
| `/doc-inject on` | Enable doc injection |
|
|
90
|
+
| `/doc-inject off` | Disable doc injection |
|
|
91
|
+
| `/doc-inject toggle` | Toggle doc injection on/off |
|
|
92
|
+
| `/doc-inject list` | List all registered docs and their injection status |
|
|
93
|
+
| `/doc-inject reset` | Reset all injected flags (docs become re-injectable) |
|
|
94
|
+
| `/doc-inject status` | Show current injection status and config |
|
|
95
|
+
| `/doc-reload` | Re-scan docs folder and rebuild registry |
|
|
95
96
|
|
|
96
97
|
## Injection Lifecycle
|
|
97
98
|
|
package/docs/bun.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "JavaScript Runtime & Package Manager"
|
|
3
|
+
keywords: [bun, package manager, runtime, install, test, build]
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# JavaScript Runtime & Package Manager
|
|
7
|
+
|
|
8
|
+
This project uses **Bun** as its JavaScript runtime and package manager.
|
|
9
|
+
|
|
10
|
+
## Why Bun?
|
|
11
|
+
|
|
12
|
+
- Fast native TypeScript support (no separate tsc step needed)
|
|
13
|
+
- All-in-one runtime, bundler, and test runner
|
|
14
|
+
- Drop-in replacement for Node.js and npm/yarn/pnpm
|
|
15
|
+
- Significantly faster installs and test executions
|
|
16
|
+
|
|
17
|
+
## Common Commands
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# Install dependencies
|
|
21
|
+
bun install
|
|
22
|
+
|
|
23
|
+
# Run tests
|
|
24
|
+
bun test
|
|
25
|
+
|
|
26
|
+
# Run tests in watch mode (recommended for development)
|
|
27
|
+
bun test --watch
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Version
|
|
31
|
+
|
|
32
|
+
This project requires Bun >= 1.3.0. The lockfile (`bun.lock`) ensures reproducible installs.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pi-doc-injector",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Auto-inject relevant project documentation into Pi's LLM context based on keyword matching",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./index.ts",
|
|
@@ -42,5 +42,5 @@
|
|
|
42
42
|
"publishConfig": {
|
|
43
43
|
"access": "public"
|
|
44
44
|
},
|
|
45
|
-
"packageManager": "
|
|
45
|
+
"packageManager": "bun@1.3.11"
|
|
46
46
|
}
|