agent-docs 1.1.0 → 1.3.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/PLAN.md +10 -10
- package/README.md +4 -0
- package/docs/A4DWORKFLOWS.md +121 -0
- package/docs/LIGHTNINGBASECOMPONENTS.md +328 -0
- package/docs/LWCHTMLTEMPLATES.md +314 -0
- package/docs/PMD.md +265 -761
- package/docs/PRETTIER.md +1 -39
- package/docs/XPATH31.md +0 -5
- package/package.json +31 -32
package/docs/PRETTIER.md
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
# Prettier Reference
|
|
2
2
|
|
|
3
|
-
> **Version**: 1.
|
|
3
|
+
> **Version**: 1.1.0
|
|
4
4
|
|
|
5
5
|
> **Architecture**: Parse → AST → Doc → Format. Plugins extend via
|
|
6
6
|
> parsers/printers. **Philosophy**: Opinionated, correctness over
|
|
7
7
|
> configurability, consistency across codebase.
|
|
8
8
|
|
|
9
|
-
---
|
|
10
|
-
|
|
11
9
|
## Core APIs
|
|
12
10
|
|
|
13
11
|
All APIs are **async**. For sync:
|
|
@@ -39,8 +37,6 @@ All APIs are **async**. For sync:
|
|
|
39
37
|
}
|
|
40
38
|
```
|
|
41
39
|
|
|
42
|
-
---
|
|
43
|
-
|
|
44
40
|
## Debug APIs
|
|
45
41
|
|
|
46
42
|
Via `prettier.__debug` namespace (internal/testing):
|
|
@@ -65,8 +61,6 @@ Via `prettier.__debug` namespace (internal/testing):
|
|
|
65
61
|
--debug-benchmark # Performance mode
|
|
66
62
|
```
|
|
67
63
|
|
|
68
|
-
---
|
|
69
|
-
|
|
70
64
|
## CLI
|
|
71
65
|
|
|
72
66
|
```bash
|
|
@@ -96,8 +90,6 @@ prettier [options] [file/dir/glob ...]
|
|
|
96
90
|
| `--cache-strategy` | `metadata` or `content` |
|
|
97
91
|
| `--stdin-filepath <path>` | Parser inference for stdin |
|
|
98
92
|
|
|
99
|
-
---
|
|
100
|
-
|
|
101
93
|
## Plugin API
|
|
102
94
|
|
|
103
95
|
### Plugin Interface
|
|
@@ -193,8 +185,6 @@ interface SupportLanguage {
|
|
|
193
185
|
}
|
|
194
186
|
```
|
|
195
187
|
|
|
196
|
-
---
|
|
197
|
-
|
|
198
188
|
## AstPath API
|
|
199
189
|
|
|
200
190
|
```typescript
|
|
@@ -245,8 +235,6 @@ const parent = path.getParentNode();
|
|
|
245
235
|
path.match((node) => node.type === 'Function');
|
|
246
236
|
```
|
|
247
237
|
|
|
248
|
-
---
|
|
249
|
-
|
|
250
238
|
## Doc Builders
|
|
251
239
|
|
|
252
240
|
Via `prettier.doc.builders`:
|
|
@@ -307,8 +295,6 @@ interface GroupOptions {
|
|
|
307
295
|
type Doc = string | Doc[] | Group | Indent | Align | Line | IfBreak | Fill | ...
|
|
308
296
|
```
|
|
309
297
|
|
|
310
|
-
---
|
|
311
|
-
|
|
312
298
|
## Doc Utilities
|
|
313
299
|
|
|
314
300
|
Via `prettier.doc.utils`:
|
|
@@ -324,8 +310,6 @@ Via `prettier.doc.utils`:
|
|
|
324
310
|
| `stripTrailingHardline` | `(doc) → Doc` | Remove trailing hardline |
|
|
325
311
|
| `replaceEndOfLine` | `(doc, replacement?) → Doc` | Replace end of line |
|
|
326
312
|
|
|
327
|
-
---
|
|
328
|
-
|
|
329
313
|
## Doc Printer
|
|
330
314
|
|
|
331
315
|
```typescript
|
|
@@ -337,8 +321,6 @@ printDocToString(doc: Doc, options: {
|
|
|
337
321
|
}): { formatted: string; cursorNodeStart?: number; cursorNodeText?: string }
|
|
338
322
|
```
|
|
339
323
|
|
|
340
|
-
---
|
|
341
|
-
|
|
342
324
|
## Options
|
|
343
325
|
|
|
344
326
|
### RequiredOptions
|
|
@@ -393,8 +375,6 @@ interface SupportOption {
|
|
|
393
375
|
}
|
|
394
376
|
```
|
|
395
377
|
|
|
396
|
-
---
|
|
397
|
-
|
|
398
378
|
## Config
|
|
399
379
|
|
|
400
380
|
### Config Interface
|
|
@@ -434,8 +414,6 @@ Search walks up directory tree. No global config.
|
|
|
434
414
|
| `indent_size`/`tab_width` | `tabWidth` |
|
|
435
415
|
| `max_line_length` | `printWidth` |
|
|
436
416
|
|
|
437
|
-
---
|
|
438
|
-
|
|
439
417
|
## Utilities
|
|
440
418
|
|
|
441
419
|
Via `prettier.util`:
|
|
@@ -496,8 +474,6 @@ All return `number | false`:
|
|
|
496
474
|
| `addTrailingComment` | `(node, comment)` | Add trailing comment |
|
|
497
475
|
| `addDanglingComment` | `(node, comment, marker)` | Add dangling comment |
|
|
498
476
|
|
|
499
|
-
---
|
|
500
|
-
|
|
501
477
|
## Architecture
|
|
502
478
|
|
|
503
479
|
### Formatting Pipeline
|
|
@@ -530,8 +506,6 @@ All return `number | false`:
|
|
|
530
506
|
|
|
531
507
|
From filepath: extension → filename → shebang → isSupported function
|
|
532
508
|
|
|
533
|
-
---
|
|
534
|
-
|
|
535
509
|
## Symbols
|
|
536
510
|
|
|
537
511
|
### Global (Symbol.for)
|
|
@@ -549,8 +523,6 @@ From filepath: extension → filename → shebang → isSupported function
|
|
|
549
523
|
| `Symbol("cursor")` | Cursor marker in diff algorithm |
|
|
550
524
|
| Group ID Symbols | For ifBreak/indentIfBreak reference |
|
|
551
525
|
|
|
552
|
-
---
|
|
553
|
-
|
|
554
526
|
## Ignored Regions
|
|
555
527
|
|
|
556
528
|
### Pragma Comments
|
|
@@ -576,8 +548,6 @@ From filepath: extension → filename → shebang → isSupported function
|
|
|
576
548
|
|
|
577
549
|
`.git`, `.jj`, `.sl`, `.svn`, `.hg`, `node_modules`
|
|
578
550
|
|
|
579
|
-
---
|
|
580
|
-
|
|
581
551
|
## Comment Handling
|
|
582
552
|
|
|
583
553
|
### Flow
|
|
@@ -612,8 +582,6 @@ Each handler receives:
|
|
|
612
582
|
) => boolean; // true = handled, false = let Prettier handle
|
|
613
583
|
```
|
|
614
584
|
|
|
615
|
-
---
|
|
616
|
-
|
|
617
585
|
## Error Types
|
|
618
586
|
|
|
619
587
|
| Error | Description |
|
|
@@ -622,8 +590,6 @@ Each handler receives:
|
|
|
622
590
|
| `UndefinedParserError` | Parser could not be inferred |
|
|
623
591
|
| `InvalidDocError` | Invalid document structure |
|
|
624
592
|
|
|
625
|
-
---
|
|
626
|
-
|
|
627
593
|
## Browser/Standalone
|
|
628
594
|
|
|
629
595
|
```typescript
|
|
@@ -638,8 +604,6 @@ await prettier.format(code, {
|
|
|
638
604
|
|
|
639
605
|
Plugins: `https://unpkg.com/prettier@VERSION/plugins/PLUGIN.mjs`
|
|
640
606
|
|
|
641
|
-
---
|
|
642
|
-
|
|
643
607
|
## Patterns
|
|
644
608
|
|
|
645
609
|
### Plugin Structure
|
|
@@ -702,8 +666,6 @@ embed: (path, options) => {
|
|
|
702
666
|
};
|
|
703
667
|
```
|
|
704
668
|
|
|
705
|
-
---
|
|
706
|
-
|
|
707
669
|
## Formatting Behavior Notes
|
|
708
670
|
|
|
709
671
|
| Behavior | Rule |
|
package/docs/XPATH31.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
````markdown
|
|
2
1
|
# XPath 3.1 Reference
|
|
3
2
|
|
|
4
3
|
> **Version**: 1.0.0
|
|
@@ -207,7 +206,3 @@ $seq ! (./child/@attr) # apply to each, flatten
|
|
|
207
206
|
- Document order preserved
|
|
208
207
|
- Namespaces: prefixes or `Q{uri}local`
|
|
209
208
|
- Errors: `try/catch` in 3.1
|
|
210
|
-
|
|
211
|
-
```
|
|
212
|
-
|
|
213
|
-
```
|
package/package.json
CHANGED
|
@@ -1,33 +1,32 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
}
|
|
2
|
+
"name": "agent-docs",
|
|
3
|
+
"version": "1.3.0",
|
|
4
|
+
"type": "module",
|
|
5
|
+
"description": "A tool for generating reusable, low-token AI agent instruction documents",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"ai",
|
|
8
|
+
"agent",
|
|
9
|
+
"documentation",
|
|
10
|
+
"docs",
|
|
11
|
+
"ide",
|
|
12
|
+
"cursor"
|
|
13
|
+
],
|
|
14
|
+
"author": "starch-uk",
|
|
15
|
+
"license": "MIT",
|
|
16
|
+
"repository": {
|
|
17
|
+
"type": "git",
|
|
18
|
+
"url": "https://github.com/starch-uk/agent-docs.git"
|
|
19
|
+
},
|
|
20
|
+
"devDependencies": {
|
|
21
|
+
"prettier": "^3.7.4"
|
|
22
|
+
},
|
|
23
|
+
"engines": {
|
|
24
|
+
"node": ">=20.0.0"
|
|
25
|
+
},
|
|
26
|
+
"scripts": {
|
|
27
|
+
"format": "prettier --write \"**/*.{ts,md,json,yml,yaml}\"",
|
|
28
|
+
"format:fix": "prettier --write \"**/*.{ts,md,json,yml,yaml}\"",
|
|
29
|
+
"format:check": "prettier --check \"**/*.{ts,md,json,yml,yaml}\"",
|
|
30
|
+
"postinstall": "node postinstall.mjs"
|
|
31
|
+
}
|
|
32
|
+
}
|