llm-docs-sync 1.0.0
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 +107 -0
- package/dist/cli.d.ts +3 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +40027 -0
- package/dist/cli.js.map +338 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +40030 -0
- package/dist/index.js.map +337 -0
- package/dist/index.test.d.ts +2 -0
- package/dist/index.test.d.ts.map +1 -0
- package/package.json +55 -0
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# @edutherapy/llm-docs-sync
|
|
2
|
+
|
|
3
|
+
A functional, Effect-based documentation sync tool for maintaining up-to-date LLM context in your SvelteKit projects.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- 🚀 **Functional & Type-Safe**: Built with Effect library for robust error handling
|
|
8
|
+
- 📦 **Bun-First**: Optimized for Bun runtime
|
|
9
|
+
- 🔄 **Auto-Sync**: Keeps your LLM documentation context fresh
|
|
10
|
+
- ⚙️ **Configurable**: Customize sources, output directory, and project rules
|
|
11
|
+
- 🎯 **SvelteKit Ready**: Pre-configured for SvelteKit + Effect projects
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
\`\`\`bash
|
|
16
|
+
bun add -d llm-docs-sync
|
|
17
|
+
\`\`\`
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
### CLI
|
|
22
|
+
|
|
23
|
+
Add to your package.json scripts:
|
|
24
|
+
|
|
25
|
+
\`\`\`json
|
|
26
|
+
{
|
|
27
|
+
"scripts": {
|
|
28
|
+
"sync-docs": "llm-docs-sync"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
\`\`\`
|
|
32
|
+
|
|
33
|
+
Run:
|
|
34
|
+
\`\`\`bash
|
|
35
|
+
bun run sync-docs
|
|
36
|
+
\`\`\`
|
|
37
|
+
|
|
38
|
+
This package is published under:
|
|
39
|
+
- **Brand**: EduTherapy (a brand of Talim Shifa Studio)
|
|
40
|
+
- **GitLab Repository**: https://gitlab.com/EduTherapy/llm-docs-sync
|
|
41
|
+
- **NPM Publisher**: edutherapy (https://www.npmjs.com/~edutherapy)
|
|
42
|
+
- **Company Website**: https://eduth.pro/
|
|
43
|
+
- **Contact**: edutherapystudio@gmail.com
|
|
44
|
+
|
|
45
|
+
### Programmatic API
|
|
46
|
+
|
|
47
|
+
\`\`\`typescript
|
|
48
|
+
import { syncDocs, DEFAULT_SOURCES, type DocSource } from 'llm-docs-sync';
|
|
49
|
+
|
|
50
|
+
// Use defaults
|
|
51
|
+
await syncDocs();
|
|
52
|
+
|
|
53
|
+
// Custom configuration
|
|
54
|
+
await syncDocs({
|
|
55
|
+
sources: [
|
|
56
|
+
...DEFAULT_SOURCES,
|
|
57
|
+
{ name: "Custom Lib", url: "https://example.com/llms.txt" }
|
|
58
|
+
],
|
|
59
|
+
outputDir: "./docs/context",
|
|
60
|
+
agentsFile: "AI_CONTEXT.md",
|
|
61
|
+
projectRules: [
|
|
62
|
+
"Use TypeScript strict mode",
|
|
63
|
+
"Follow Effect best practices"
|
|
64
|
+
]
|
|
65
|
+
});
|
|
66
|
+
\`\`\`
|
|
67
|
+
|
|
68
|
+
### Default Sources
|
|
69
|
+
|
|
70
|
+
- Svelte 5
|
|
71
|
+
- SvelteKit
|
|
72
|
+
- Effect
|
|
73
|
+
- Tailwind v4
|
|
74
|
+
- Lucide
|
|
75
|
+
- Vite
|
|
76
|
+
- Biome
|
|
77
|
+
|
|
78
|
+
## Configuration
|
|
79
|
+
|
|
80
|
+
\`\`\`typescript
|
|
81
|
+
type SyncConfig = {
|
|
82
|
+
sources?: DocSource[]; // Documentation sources to sync
|
|
83
|
+
outputDir?: string; // Output directory (default: ./.opencode/context)
|
|
84
|
+
agentsFile?: string; // AGENTS.md file path (default: AGENTS.md)
|
|
85
|
+
projectRules?: string[]; // Custom project rules
|
|
86
|
+
};
|
|
87
|
+
\`\`\`
|
|
88
|
+
|
|
89
|
+
## Example Workflow
|
|
90
|
+
|
|
91
|
+
1. Install the package
|
|
92
|
+
2. Add sync script to package.json
|
|
93
|
+
3. Run before starting development or in CI/CD
|
|
94
|
+
4. Your AGENTS.md and context files stay updated
|
|
95
|
+
|
|
96
|
+
\`\`\`json
|
|
97
|
+
{
|
|
98
|
+
"scripts": {
|
|
99
|
+
"predev": "bun run sync-docs",
|
|
100
|
+
"dev": "vite dev"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
\`\`\`
|
|
104
|
+
|
|
105
|
+
## License
|
|
106
|
+
|
|
107
|
+
MIT
|
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}
|