docworks 0.16.0 → 0.17.0-next.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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Caio Pizzol
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -27,6 +27,8 @@ DocWorks tests documentation the way developers actually use it - by having AI s
27
27
 
28
28
  ## Configuration
29
29
 
30
+ See [`schema.yaml`](./schema.yaml) for the complete configuration schema with validation rules.
31
+
30
32
  ### Simple Questions
31
33
 
32
34
  ```yaml
@@ -38,7 +40,7 @@ questions:
38
40
  - What are the rate limits?
39
41
  - Where are code examples?
40
42
 
41
- provider: openai
43
+ provider: openai # Currently only OpenAI supported
42
44
  model: gpt-4o-mini
43
45
  ```
44
46
 
@@ -137,40 +139,15 @@ jobs:
137
139
  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
138
140
  ```
139
141
 
140
- ### Multi-Model Testing
142
+ ## Supported Providers
141
143
 
142
- Test against multiple AI models:
144
+ | Provider | Status | Models |
145
+ | --------- | -------------- | ---------------------------------- |
146
+ | OpenAI | ✅ Supported | gpt-4o, gpt-4o-mini |
147
+ | Anthropic | 🚧 Coming Soon | claude-3.7-sonnet, claude-4-sonnet |
148
+ | Google | 🚧 Coming Soon | gemini-pro |
143
149
 
144
- ```yaml
145
- # .github/workflows/docs.yml
146
- name: Documentation Validation
147
- on: [pull_request]
148
-
149
- jobs:
150
- validate:
151
- strategy:
152
- matrix:
153
- include:
154
- - provider: openai
155
- model: gpt-4o
156
- threshold: 90
157
- - provider: openai
158
- model: gpt-4o-mini
159
- threshold: 85
160
- - provider: anthropic
161
- model: claude-3-opus
162
- threshold: 90
163
-
164
- runs-on: ubuntu-latest
165
- steps:
166
- - uses: actions/checkout@v3
167
- - run: npx docworks check --threshold ${{ matrix.threshold }}
168
- env:
169
- PROVIDER: ${{ matrix.provider }}
170
- MODEL: ${{ matrix.model }}
171
- OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
172
- ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
173
- ```
150
+ **Want to add a provider?** PRs welcome! See [`src/providers/index.ts`](./src/providers/index.ts).
174
151
 
175
152
  ## Supported Documentation
176
153
 
@@ -218,6 +195,23 @@ Start lenient and increase strictness as your documentation improves:
218
195
  3. **Staging** - `threshold: 90` (nearly complete)
219
196
  4. **Production** - `threshold: 95-100` (comprehensive docs)
220
197
 
198
+ ## Requirements
199
+
200
+ - Node.js 16+
201
+ - OpenAI API key with web search capabilities
202
+
203
+ ## Contributing
204
+
205
+ Contributions welcome! We're especially looking for:
206
+
207
+ - Additional provider implementations (Anthropic, Google)
208
+ - Documentation platform integrations
209
+ - Journey templates for common use cases
210
+
211
+ ### Development Setup
212
+
213
+ Pre-commit hooks are automatically installed when you run `pnpm install`. These hooks run linting and formatting checks before each commit to ensure code quality. If you need to bypass them (not recommended), use `git commit --no-verify`.
214
+
221
215
  ## Why DocWorks?
222
216
 
223
217
  - **Real-world testing** - AI navigates docs like developers do
@@ -228,4 +222,4 @@ Start lenient and increase strictness as your documentation improves:
228
222
 
229
223
  ## License
230
224
 
231
- MIT
225
+ MIT - See [LICENSE](./LICENSE) for details
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAoCrD,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gBAAgB,CAAC,CAgE3B"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAoCrD,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,gBAAgB,CAAC,CAkE3B"}
@@ -83,10 +83,10 @@ Instructions:
83
83
  };
84
84
  }
85
85
  }
86
- case 'anthropic': {
87
- // Similar implementation
88
- throw new Error('Anthropic not yet implemented');
89
- }
86
+ // Future providers - PRs welcome!
87
+ case 'anthropic':
88
+ case 'google':
89
+ throw new Error(`${provider} provider coming soon. Currently only 'openai' is supported.`);
90
90
  default:
91
91
  throw new Error(`Unknown provider: ${provider}`);
92
92
  }
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAG3B,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE,aAAsB;IAC5B,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC;aAC/B;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sBAAsB;aACpC;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,WAAW,EAAE,6BAA6B;aAC3C;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mBAAmB;aACjC;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;gBACvB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,WAAW,EAAE,mDAAmD;aACjE;SACF;QACD,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;QACnE,oBAAoB,EAAE,KAAK;KAC5B;CACF,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,IAAY;IAEZ,MAAM,MAAM,GAAG;EACf,IAAI;;sCAEgC,QAAQ;;;;;;qCAMT,CAAA;IAEnC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YAErC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;oBAC7C,KAAK;oBACL,KAAK,EAAE,MAAM;oBACb,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,oBAAoB;yBAC3B;qBACF;oBACD,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE;wBACJ,MAAM,EAAE,iBAAiB;qBAC1B;iBACF,CAAC,CAAA;gBAEF,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAA;gBACpC,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;gBACpD,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAElC,OAAO;oBACL,QAAQ;oBACR,GAAG,MAAM;iBACV,CAAA;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAA;gBACzC,oBAAoB;gBACpB,OAAO;oBACL,QAAQ;oBACR,UAAU,EAAE,IAAI;oBAChB,UAAU,EAAE,CAAC;oBACb,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,qCAAqC;oBAC7C,OAAO,EAAE,CAAC,+BAA+B,CAAC;iBAC3C,CAAA;YACH,CAAC;QACH,CAAC;QAED,KAAK,WAAW,CAAC,CAAC,CAAC;YACjB,yBAAyB;YACzB,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAA;QAClD,CAAC;QAED;YACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAA;IACpD,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/providers/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAG3B,MAAM,iBAAiB,GAAG;IACxB,IAAI,EAAE,aAAsB;IAC5B,IAAI,EAAE,gBAAgB;IACtB,MAAM,EAAE;QACN,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC;aAC/B;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,sBAAsB;aACpC;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,WAAW,EAAE,6BAA6B;aAC3C;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,mBAAmB;aACjC;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;gBACvB,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACzB,WAAW,EAAE,mDAAmD;aACjE;SACF;QACD,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC;QACnE,oBAAoB,EAAE,KAAK;KAC5B;CACF,CAAA;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,KAAa,EACb,MAAc,EACd,QAAgB,EAChB,IAAY;IAEZ,MAAM,MAAM,GAAG;EACf,IAAI;;sCAEgC,QAAQ;;;;;;qCAMT,CAAA;IAEnC,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC,CAAA;YAErC,IAAI,CAAC;gBACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC;oBAC7C,KAAK;oBACL,KAAK,EAAE,MAAM;oBACb,KAAK,EAAE;wBACL;4BACE,IAAI,EAAE,oBAAoB;yBAC3B;qBACF;oBACD,WAAW,EAAE,UAAU;oBACvB,IAAI,EAAE;wBACJ,MAAM,EAAE,iBAAiB;qBAC1B;iBACF,CAAC,CAAA;gBAEF,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAA;gBACpC,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;gBACpD,CAAC;gBAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;gBAElC,OAAO;oBACL,QAAQ;oBACR,GAAG,MAAM;iBACV,CAAA;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAA;gBACzC,oBAAoB;gBACpB,OAAO;oBACL,QAAQ;oBACR,UAAU,EAAE,IAAI;oBAChB,UAAU,EAAE,CAAC;oBACb,IAAI,EAAE,EAAE;oBACR,MAAM,EAAE,qCAAqC;oBAC7C,OAAO,EAAE,CAAC,+BAA+B,CAAC;iBAC3C,CAAA;YACH,CAAC;QACH,CAAC;QAED,kCAAkC;QAClC,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,MAAM,IAAI,KAAK,CACb,GAAG,QAAQ,8DAA8D,CAC1E,CAAA;QAEH;YACE,MAAM,IAAI,KAAK,CAAC,qBAAqB,QAAQ,EAAE,CAAC,CAAA;IACpD,CAAC;AACH,CAAC"}
@@ -1,4 +1,4 @@
1
- export declare function fetchDocumentation(url: string): Promise<{
1
+ export declare function fetchDocumentation(source: string): Promise<{
2
2
  content: string;
3
3
  name: string;
4
4
  }>;
@@ -1 +1 @@
1
- {"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CA0B5C"}
1
+ {"version":3,"file":"source.d.ts","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AA2DA,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAY5C"}
@@ -1,23 +1,58 @@
1
- export async function fetchDocumentation(url) {
1
+ import fs from 'fs';
2
+ import path from 'path';
3
+ function isUrl(source) {
2
4
  try {
3
- // Try to fetch llms.txt
4
- const llmsTxtUrl = new URL('/llms.txt', url).href;
5
- console.log(`Fetching ${llmsTxtUrl}...`);
6
- let response = await fetch(llmsTxtUrl);
5
+ // Check for protocol
6
+ if (!source.includes('://')) {
7
+ return false;
8
+ }
9
+ // Try to construct a URL object - will throw if invalid
10
+ new URL(source);
11
+ return true;
12
+ }
13
+ catch {
14
+ return false;
15
+ }
16
+ }
17
+ async function readFromFile(filePath) {
18
+ const resolvedPath = path.resolve(filePath);
19
+ if (!fs.existsSync(resolvedPath)) {
20
+ throw new Error(`File not found: ${resolvedPath}`);
21
+ }
22
+ console.log(`Reading ${resolvedPath}...`);
23
+ const content = fs.readFileSync(resolvedPath, 'utf-8');
24
+ const name = `${path.basename(resolvedPath)} from local file`;
25
+ console.log('✓ Loaded documentation\n');
26
+ return { content, name };
27
+ }
28
+ async function fetchFromUrl(url) {
29
+ // Try to fetch llms.txt
30
+ const llmsTxtUrl = new URL('/llms.txt', url).href;
31
+ console.log(`Fetching ${llmsTxtUrl}...`);
32
+ let response = await fetch(llmsTxtUrl);
33
+ if (!response.ok) {
34
+ // Maybe they provided the llms.txt URL directly
35
+ response = await fetch(url);
7
36
  if (!response.ok) {
8
- // Maybe they provided the llms.txt URL directly
9
- response = await fetch(url);
10
- if (!response.ok) {
11
- throw new Error(`No llms.txt found at ${url}`);
12
- }
37
+ throw new Error(`No llms.txt found at ${url}`);
38
+ }
39
+ }
40
+ const content = await response.text();
41
+ const name = `llms.txt from ${new URL(url).hostname}`;
42
+ console.log('✓ Fetched documentation\n');
43
+ return { content, name };
44
+ }
45
+ export async function fetchDocumentation(source) {
46
+ try {
47
+ if (isUrl(source)) {
48
+ return await fetchFromUrl(source);
49
+ }
50
+ else {
51
+ return await readFromFile(source);
13
52
  }
14
- const content = await response.text();
15
- const name = `llms.txt from ${new URL(url).hostname}`;
16
- console.log('✓ Fetched documentation\n');
17
- return { content, name };
18
53
  }
19
54
  catch (error) {
20
- throw new Error(`Failed to fetch documentation from ${url}: ${error.message}`);
55
+ throw new Error(`Failed to fetch documentation from ${source}: ${error.message}`);
21
56
  }
22
57
  }
23
58
  //# sourceMappingURL=source.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"source.js","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,GAAW;IAEX,IAAI,CAAC;QACH,wBAAwB;QACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA;QAEjD,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,KAAK,CAAC,CAAA;QACxC,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;QAEtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,gDAAgD;YAChD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;YAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAA;YAChD,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QACrC,MAAM,IAAI,GAAG,iBAAiB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;QAErD,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;QACxC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;IAC1B,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sCAAsC,GAAG,KAAK,KAAK,CAAC,OAAO,EAAE,CAC9D,CAAA;IACH,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"source.js","sourceRoot":"","sources":["../../src/sources/source.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,IAAI,MAAM,MAAM,CAAA;AAEvB,SAAS,KAAK,CAAC,MAAc;IAC3B,IAAI,CAAC;QACH,qBAAqB;QACrB,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,wDAAwD;QACxD,IAAI,GAAG,CAAC,MAAM,CAAC,CAAA;QACf,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,QAAgB;IAEhB,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;IAE3C,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAA;IACpD,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,WAAW,YAAY,KAAK,CAAC,CAAA;IACzC,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;IACtD,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAAkB,CAAA;IAE7D,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAA;IACvC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED,KAAK,UAAU,YAAY,CACzB,GAAW;IAEX,wBAAwB;IACxB,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,IAAI,CAAA;IAEjD,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,KAAK,CAAC,CAAA;IACxC,IAAI,QAAQ,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,CAAA;IAEtC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,gDAAgD;QAChD,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAA;QAC3B,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,GAAG,EAAE,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;IACrC,MAAM,IAAI,GAAG,iBAAiB,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAA;IAErD,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAA;IACxC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAA;AAC1B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAAc;IAEd,IAAI,CAAC;QACH,IAAI,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAClB,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,YAAY,CAAC,MAAM,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAAC,OAAO,KAAU,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sCAAsC,MAAM,KAAK,KAAK,CAAC,OAAO,EAAE,CACjE,CAAA;IACH,CAAC;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docworks",
3
- "version": "0.16.0",
3
+ "version": "0.17.0-next.2",
4
4
  "description": "Ensure your docs work for developers and AI",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -9,8 +9,10 @@
9
9
  },
10
10
  "scripts": {
11
11
  "build": "tsc",
12
+ "build:standalone": "npm run build && npx @vercel/ncc build dist/index.js -o standalone -m",
12
13
  "test": "echo \"Error: no test specified\" && exit 1",
13
14
  "dev": "tsc --watch",
15
+ "prepare": "husky",
14
16
  "prepublishOnly": "npm run build",
15
17
  "format": "prettier --write .",
16
18
  "format:check": "prettier --check .",
@@ -29,6 +31,8 @@
29
31
  "yaml": "^2.0.0"
30
32
  },
31
33
  "devDependencies": {
34
+ "@commitlint/cli": "^20.1.0",
35
+ "@commitlint/config-conventional": "^20.0.0",
32
36
  "@eslint/js": "^9.35.0",
33
37
  "@semantic-release/changelog": "^6.0.3",
34
38
  "@semantic-release/exec": "^7.1.0",
@@ -41,7 +45,6 @@
41
45
  "eslint-config-prettier": "^10.1.8",
42
46
  "husky": "^9.1.7",
43
47
  "lint-staged": "^16.1.6",
44
- "node": "link:@@types/node",
45
48
  "prettier": "^3.6.2",
46
49
  "semantic-release": "^24.2.7",
47
50
  "typescript": "^5.0.0",