@fuzdev/fuz_ui 0.191.1 โ†’ 0.191.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.
Files changed (66) hide show
  1. package/dist/Alert.svelte +1 -1
  2. package/dist/ProjectLinks.svelte +3 -1
  3. package/dist/ProjectLinks.svelte.d.ts.map +1 -1
  4. package/dist/analysis_context.d.ts +7 -3
  5. package/dist/analysis_context.d.ts.map +1 -1
  6. package/dist/analysis_context.js +7 -3
  7. package/dist/contextmenu_state.svelte.d.ts +3 -3
  8. package/dist/contextmenu_state.svelte.js +3 -3
  9. package/dist/csp.d.ts +4 -4
  10. package/dist/csp.js +4 -4
  11. package/dist/docs_helpers.svelte.d.ts +1 -1
  12. package/dist/docs_helpers.svelte.js +1 -1
  13. package/dist/library.svelte.d.ts +4 -4
  14. package/dist/library.svelte.js +4 -4
  15. package/dist/library_analysis.d.ts +4 -4
  16. package/dist/library_analysis.d.ts.map +1 -1
  17. package/dist/library_analysis.js +3 -3
  18. package/dist/library_gen.d.ts +10 -8
  19. package/dist/library_gen.d.ts.map +1 -1
  20. package/dist/library_gen.js +8 -8
  21. package/dist/library_generate.d.ts +2 -2
  22. package/dist/library_generate.js +2 -2
  23. package/dist/library_helpers.d.ts +2 -0
  24. package/dist/library_helpers.d.ts.map +1 -1
  25. package/dist/library_helpers.js +2 -0
  26. package/dist/library_output.d.ts +7 -7
  27. package/dist/library_output.d.ts.map +1 -1
  28. package/dist/library_output.js +5 -5
  29. package/dist/library_pipeline.d.ts +9 -5
  30. package/dist/library_pipeline.d.ts.map +1 -1
  31. package/dist/library_pipeline.js +9 -5
  32. package/dist/logos.d.ts +8 -1
  33. package/dist/logos.d.ts.map +1 -1
  34. package/dist/logos.js +8 -3
  35. package/dist/module.svelte.d.ts +1 -1
  36. package/dist/module.svelte.js +1 -1
  37. package/dist/module_helpers.d.ts +2 -2
  38. package/dist/module_helpers.js +1 -1
  39. package/dist/package_helpers.d.ts +4 -4
  40. package/dist/package_helpers.js +4 -4
  41. package/dist/svelte_preprocess_mdz.d.ts +4 -4
  42. package/dist/svelte_preprocess_mdz.js +6 -6
  43. package/dist/ts_helpers.d.ts +4 -4
  44. package/dist/ts_helpers.d.ts.map +1 -1
  45. package/dist/ts_helpers.js +2 -2
  46. package/dist/vite_plugin_library_well_known.d.ts +2 -2
  47. package/dist/vite_plugin_library_well_known.js +1 -1
  48. package/package.json +4 -4
  49. package/src/lib/analysis_context.ts +7 -3
  50. package/src/lib/contextmenu_state.svelte.ts +3 -3
  51. package/src/lib/csp.ts +4 -4
  52. package/src/lib/docs_helpers.svelte.ts +1 -1
  53. package/src/lib/library.svelte.ts +4 -4
  54. package/src/lib/library_analysis.ts +4 -4
  55. package/src/lib/library_gen.ts +10 -8
  56. package/src/lib/library_generate.ts +2 -2
  57. package/src/lib/library_helpers.ts +2 -0
  58. package/src/lib/library_output.ts +7 -7
  59. package/src/lib/library_pipeline.ts +9 -5
  60. package/src/lib/logos.ts +9 -3
  61. package/src/lib/module.svelte.ts +1 -1
  62. package/src/lib/module_helpers.ts +2 -2
  63. package/src/lib/package_helpers.ts +4 -4
  64. package/src/lib/svelte_preprocess_mdz.ts +14 -14
  65. package/src/lib/ts_helpers.ts +4 -4
  66. package/src/lib/vite_plugin_library_well_known.ts +2 -2
package/dist/Alert.svelte CHANGED
@@ -5,7 +5,7 @@
5
5
  import {alert_status_options, type AlertStatus} from './alert.js';
6
6
 
7
7
  /**
8
- * @see https://www.w3.org/WAI/ARIA/apg/patterns/alert/
8
+ * @see {@link https://www.w3.org/WAI/ARIA/apg/patterns/alert/}
9
9
  *
10
10
  * @module
11
11
  */
@@ -13,6 +13,7 @@
13
13
  logo_fuz_util,
14
14
  logo_gro,
15
15
  logo_fuz_docs,
16
+ logo_fuz_app,
16
17
  } from './logos.js';
17
18
 
18
19
  // TODO refactor
@@ -28,8 +29,9 @@
28
29
  // TODO ideally this wouldn't duplicate metadata like descriptions, but adding fuz_gitops to this repo is heavy
29
30
  // prettier-ignore
30
31
  const project_items: Array<ProjectItem> = [
31
- {name: 'fuz_ui', url: 'https://ui.fuz.dev/', logo: logo_fuz_ui, description: 'Svelte UI library', glyph: '๐Ÿงถ', color_class: 'color_c_50'},
32
+ {name: 'fuz_app', url: 'https://app.fuz.dev/', logo: logo_fuz_app, description: 'fullstack app library', glyph: '๐Ÿ—', color_class: 'color_j_50'},
32
33
  {name: 'fuz_css', url: 'https://css.fuz.dev/', logo: logo_fuz_css, description: 'CSS framework and design system', glyph: '๐ŸŒฟ', color_class: 'color_b_50'},
34
+ {name: 'fuz_ui', url: 'https://ui.fuz.dev/', logo: logo_fuz_ui, description: 'Svelte UI library', glyph: '๐Ÿงถ', color_class: 'color_c_50'},
33
35
  {name: 'fuz_template', url: 'https://template.fuz.dev/', logo: logo_fuz_template, description: 'a static web app and Node library template with TypeScript, Svelte, SvelteKit, Vite, esbuild, Fuz, and Gro', glyph: 'โ„', color_class: 'color_h_50'},
34
36
  {name: 'fuz_code', url: 'https://code.fuz.dev/', logo: logo_fuz_code, description: 'syntax styling utilities and components for TypeScript, Svelte, SvelteKit', glyph: '๐ŸŽจ', color_class: 'color_g_50'},
35
37
  {name: 'fuz_blog', url: 'https://blog.fuz.dev/', logo: logo_fuz_blog, description: 'blog software from scratch with SvelteKit', glyph: '๐Ÿ–Š๏ธ', color_class: 'color_e_50'},
@@ -1 +1 @@
1
- {"version":3,"file":"ProjectLinks.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/ProjectLinks.svelte"],"names":[],"mappings":"AAwEA,UAAU,kCAAkC,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,MAAM;IACpM,KAAK,OAAO,EAAE,OAAO,QAAQ,EAAE,2BAA2B,CAAC,KAAK,CAAC,GAAG,OAAO,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG;QAAE,UAAU,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC;IACjK,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,CAAA;KAAC,GAAG,OAAO,GAAG;QAAE,IAAI,CAAC,EAAE,GAAG,CAAC;QAAC,GAAG,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IACtG,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B;AAKD,QAAA,MAAM,YAAY;;kBAA+E,CAAC;AAChF,KAAK,YAAY,GAAG,YAAY,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,eAAe,YAAY,CAAC"}
1
+ {"version":3,"file":"ProjectLinks.svelte.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/ProjectLinks.svelte"],"names":[],"mappings":"AA0EA,UAAU,kCAAkC,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,GAAG,MAAM;IACpM,KAAK,OAAO,EAAE,OAAO,QAAQ,EAAE,2BAA2B,CAAC,KAAK,CAAC,GAAG,OAAO,QAAQ,EAAE,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG;QAAE,UAAU,CAAC,EAAE,QAAQ,CAAA;KAAE,GAAG,OAAO,CAAC;IACjK,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,KAAK,CAAA;KAAC,GAAG,OAAO,GAAG;QAAE,IAAI,CAAC,EAAE,GAAG,CAAC;QAAC,GAAG,CAAC,EAAE,GAAG,CAAA;KAAE,CAAC;IACtG,YAAY,CAAC,EAAE,QAAQ,CAAC;CAC3B;AAKD,QAAA,MAAM,YAAY;;kBAA+E,CAAC;AAChF,KAAK,YAAY,GAAG,YAAY,CAAC,OAAO,YAAY,CAAC,CAAC;AACxD,eAAe,YAAY,CAAC"}
@@ -8,7 +8,7 @@
8
8
  *
9
9
  * Analysis functions follow a two-tier error model:
10
10
  *
11
- * **Accumulated (non-fatal)** - Collected in AnalysisContext, analysis continues:
11
+ * **Accumulated (non-fatal)** - Collected in `AnalysisContext`, analysis continues:
12
12
  * - Type resolution failures (complex generics, circular refs)
13
13
  * - Missing or unparseable JSDoc
14
14
  * - Individual member/prop extraction failures
@@ -44,6 +44,7 @@
44
44
  * ```
45
45
  *
46
46
  * @example
47
+ * ```ts
47
48
  * const ctx = new AnalysisContext();
48
49
  * // ... analysis functions add diagnostics via ctx.add(...)
49
50
  * if (ctx.has_errors()) {
@@ -51,6 +52,7 @@
51
52
  * console.error(`${err.file}:${err.line}: ${err.message}`);
52
53
  * }
53
54
  * }
55
+ * ```
54
56
  *
55
57
  * @module
56
58
  */
@@ -137,6 +139,7 @@ export type Diagnostic = TypeExtractionDiagnostic | SignatureAnalysisDiagnostic
137
139
  * report collected diagnostics.
138
140
  *
139
141
  * @example
142
+ * ```ts
140
143
  * const ctx = new AnalysisContext();
141
144
  * ts_analyze_module_exports(source_file, checker, options, ctx);
142
145
  * if (ctx.has_errors()) {
@@ -145,11 +148,12 @@ export type Diagnostic = TypeExtractionDiagnostic | SignatureAnalysisDiagnostic
145
148
  * console.error(format_diagnostic(d));
146
149
  * }
147
150
  * }
151
+ * ```
148
152
  */
149
153
  export declare class AnalysisContext {
150
154
  readonly diagnostics: Array<Diagnostic>;
151
155
  /**
152
- * Add a diagnostic to the collection.
156
+ * Add a `Diagnostic` to the collection.
153
157
  */
154
158
  add(diagnostic: Diagnostic): void;
155
159
  /**
@@ -169,7 +173,7 @@ export declare class AnalysisContext {
169
173
  */
170
174
  warnings(): Array<Diagnostic>;
171
175
  /**
172
- * Get diagnostics of a specific kind.
176
+ * Get diagnostics of a specific `DiagnosticKind`.
173
177
  */
174
178
  by_kind<K extends DiagnosticKind>(kind: K): Array<Extract<Diagnostic, {
175
179
  kind: K;
@@ -1 +1 @@
1
- {"version":3,"file":"analysis_context.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/analysis_context.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,cAAc,GACvB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,oBAAoB,GACpB,gBAAgB,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,cAAc,CAAC;IACrB,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gEAAgE;IAChE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC/D,IAAI,EAAE,wBAAwB,CAAC;IAC/B,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IAClE,IAAI,EAAE,2BAA2B,CAAC;IAClC,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC5D,IAAI,EAAE,qBAAqB,CAAC;IAC5B,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC3D,IAAI,EAAE,oBAAoB,CAAC;IAC3B,6BAA6B;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC9D,IAAI,EAAE,gBAAgB,CAAC;IACvB,qCAAqC;IACrC,MAAM,EAAE,gBAAgB,GAAG,aAAa,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GACnB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAC;AAE3B;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,eAAe;IAC3B,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAM;IAE7C;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIjC;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB;;OAEG;IACH,YAAY,IAAI,OAAO;IAIvB;;OAEG;IACH,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;IAI3B;;OAEG;IACH,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC;IAI7B;;OAEG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;QAAC,IAAI,EAAE,CAAC,CAAA;KAAC,CAAC,CAAC;CAGjF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC7B,YAAY,UAAU,EACtB,UAAU,uBAAuB,KAC/B,MAeF,CAAC"}
1
+ {"version":3,"file":"analysis_context.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/analysis_context.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AAEH;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,SAAS,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,cAAc,GACvB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,oBAAoB,GACpB,gBAAgB,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,cAAc,CAAC;IACrB,qEAAqE;IACrE,IAAI,EAAE,MAAM,CAAC;IACb,8DAA8D;IAC9D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gEAAgE;IAChE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,+CAA+C;IAC/C,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,kBAAkB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC/D,IAAI,EAAE,wBAAwB,CAAC;IAC/B,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IAClE,IAAI,EAAE,2BAA2B,CAAC;IAClC,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC5D,IAAI,EAAE,qBAAqB,CAAC;IAC5B,yBAAyB;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,cAAc;IAC3D,IAAI,EAAE,oBAAoB,CAAC;IAC3B,6BAA6B;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,SAAS,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC9D,IAAI,EAAE,gBAAgB,CAAC;IACvB,qCAAqC;IACrC,MAAM,EAAE,gBAAgB,GAAG,aAAa,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GACnB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,oBAAoB,GACpB,uBAAuB,CAAC;AAE3B;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,eAAe;IAC3B,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAC,CAAM;IAE7C;;OAEG;IACH,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAIjC;;OAEG;IACH,UAAU,IAAI,OAAO;IAIrB;;OAEG;IACH,YAAY,IAAI,OAAO;IAIvB;;OAEG;IACH,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC;IAI3B;;OAEG;IACH,QAAQ,IAAI,KAAK,CAAC,UAAU,CAAC;IAI7B;;OAEG;IACH,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE;QAAC,IAAI,EAAE,CAAC,CAAA;KAAC,CAAC,CAAC;CAGjF;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAC7B,YAAY,UAAU,EACtB,UAAU,uBAAuB,KAC/B,MAeF,CAAC"}
@@ -8,7 +8,7 @@
8
8
  *
9
9
  * Analysis functions follow a two-tier error model:
10
10
  *
11
- * **Accumulated (non-fatal)** - Collected in AnalysisContext, analysis continues:
11
+ * **Accumulated (non-fatal)** - Collected in `AnalysisContext`, analysis continues:
12
12
  * - Type resolution failures (complex generics, circular refs)
13
13
  * - Missing or unparseable JSDoc
14
14
  * - Individual member/prop extraction failures
@@ -44,6 +44,7 @@
44
44
  * ```
45
45
  *
46
46
  * @example
47
+ * ```ts
47
48
  * const ctx = new AnalysisContext();
48
49
  * // ... analysis functions add diagnostics via ctx.add(...)
49
50
  * if (ctx.has_errors()) {
@@ -51,6 +52,7 @@
51
52
  * console.error(`${err.file}:${err.line}: ${err.message}`);
52
53
  * }
53
54
  * }
55
+ * ```
54
56
  *
55
57
  * @module
56
58
  */
@@ -62,6 +64,7 @@
62
64
  * report collected diagnostics.
63
65
  *
64
66
  * @example
67
+ * ```ts
65
68
  * const ctx = new AnalysisContext();
66
69
  * ts_analyze_module_exports(source_file, checker, options, ctx);
67
70
  * if (ctx.has_errors()) {
@@ -70,11 +73,12 @@
70
73
  * console.error(format_diagnostic(d));
71
74
  * }
72
75
  * }
76
+ * ```
73
77
  */
74
78
  export class AnalysisContext {
75
79
  diagnostics = [];
76
80
  /**
77
- * Add a diagnostic to the collection.
81
+ * Add a `Diagnostic` to the collection.
78
82
  */
79
83
  add(diagnostic) {
80
84
  this.diagnostics.push(diagnostic);
@@ -104,7 +108,7 @@ export class AnalysisContext {
104
108
  return this.diagnostics.filter((d) => d.severity === 'warning');
105
109
  }
106
110
  /**
107
- * Get diagnostics of a specific kind.
111
+ * Get diagnostics of a specific `DiagnosticKind`.
108
112
  */
109
113
  by_kind(kind) {
110
114
  return this.diagnostics.filter((d) => d.kind === kind);
@@ -56,10 +56,10 @@ export interface ContextmenuStateOptions {
56
56
  layout?: Dimensions;
57
57
  }
58
58
  /**
59
- * Creates a `contextmenu` store.
59
+ * Creates a contextmenu store.
60
60
  * See usage with `ContextmenuRoot.svelte` and `Contextmenu.svelte`.
61
61
  *
62
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event
62
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event}
63
63
  */
64
64
  export declare class ContextmenuState {
65
65
  layout: Dimensions;
@@ -97,7 +97,7 @@ export declare class ContextmenuState {
97
97
  select_first(): void;
98
98
  select_last(): void;
99
99
  /**
100
- * Used by `ContextmenuEntry` and custom entry components
100
+ * Used by `ContextmenuEntry.svelte` and custom entry components.
101
101
  * @initializes
102
102
  */
103
103
  add_entry(run: () => ContextmenuRun, disabled?: () => boolean): EntryState;
@@ -38,10 +38,10 @@ export class RootMenuState {
38
38
  items = $state.raw([]);
39
39
  }
40
40
  /**
41
- * Creates a `contextmenu` store.
41
+ * Creates a contextmenu store.
42
42
  * See usage with `ContextmenuRoot.svelte` and `Contextmenu.svelte`.
43
43
  *
44
- * @see https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event
44
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/Element/contextmenu_event}
45
45
  */
46
46
  export class ContextmenuState {
47
47
  layout; // TODO $state?
@@ -262,7 +262,7 @@ export class ContextmenuState {
262
262
  this.select(items.at(-1));
263
263
  }
264
264
  /**
265
- * Used by `ContextmenuEntry` and custom entry components
265
+ * Used by `ContextmenuEntry.svelte` and custom entry components.
266
266
  * @initializes
267
267
  */
268
268
  add_entry(run, disabled = () => false) {
package/dist/csp.d.ts CHANGED
@@ -50,7 +50,7 @@ export declare const parse_csp_directive: (directive: unknown) => CspDirective |
50
50
  export type CspDirectiveValue<T extends CspDirective> = Defined<CspDirectives[T]>;
51
51
  export declare const csp_trust_levels: readonly ["low", "medium", "high"];
52
52
  /**
53
- * Numeric values for CSP trust levels, `csp_trust_levels`.
53
+ * Numeric values for CSP trust levels. See `csp_trust_levels`.
54
54
  * Lower is less trusted.
55
55
  * Includes `undefined` in the type for safety.
56
56
  */
@@ -98,7 +98,7 @@ export declare const COLOR_SCHEME_SCRIPT_HASH = "sha256-QOxqn7EUzb3ydF9SALJoJGWS
98
98
  /**
99
99
  * The base CSP directive defaults.
100
100
  * Prioritizes safety but loosens around media and styles, relying on defense-in-depth.
101
- * Customizable via `CreateCspDirectivesOptions.defaults`.
101
+ * Customizable via `CreateCspDirectivesOptions`.
102
102
  */
103
103
  export declare const csp_directive_value_defaults: Record<CspDirective, CspDirectiveValue<CspDirective> | null>;
104
104
  /**
@@ -114,9 +114,9 @@ export declare const csp_directive_required_trust_defaults: Record<CspDirective,
114
114
  * Fuz excludes deprecated directives, so those are intentionally omitted,
115
115
  * but any newer missing directives are bugs.
116
116
  *
117
- * Could be moved to `csp.ts` but is currently here to keep that module smaller.
117
+ * Could be co-located but is currently here to keep that module smaller.
118
118
  *
119
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy
119
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy}
120
120
  */
121
121
  export declare const csp_directive_specs: Array<CspDirectiveSpec>;
122
122
  export declare const csp_directive_spec_by_name: Map<CspDirective, CspDirectiveSpec>;
package/dist/csp.js CHANGED
@@ -104,7 +104,7 @@ export const parse_csp_directive = (directive) => typeof directive === 'string'
104
104
  : null;
105
105
  export const csp_trust_levels = ['low', 'medium', 'high'];
106
106
  /**
107
- * Numeric values for CSP trust levels, `csp_trust_levels`.
107
+ * Numeric values for CSP trust levels. See `csp_trust_levels`.
108
108
  * Lower is less trusted.
109
109
  * Includes `undefined` in the type for safety.
110
110
  */
@@ -144,7 +144,7 @@ export const COLOR_SCHEME_SCRIPT_HASH = 'sha256-QOxqn7EUzb3ydF9SALJoJGWSvywW9R0A
144
144
  /**
145
145
  * The base CSP directive defaults.
146
146
  * Prioritizes safety but loosens around media and styles, relying on defense-in-depth.
147
- * Customizable via `CreateCspDirectivesOptions.defaults`.
147
+ * Customizable via `CreateCspDirectivesOptions`.
148
148
  */
149
149
  export const csp_directive_value_defaults = {
150
150
  'default-src': ['none'],
@@ -210,9 +210,9 @@ export const csp_directive_required_trust_defaults = {
210
210
  * Fuz excludes deprecated directives, so those are intentionally omitted,
211
211
  * but any newer missing directives are bugs.
212
212
  *
213
- * Could be moved to `csp.ts` but is currently here to keep that module smaller.
213
+ * Could be co-located but is currently here to keep that module smaller.
214
214
  *
215
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy
215
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy}
216
216
  */
217
217
  export const csp_directive_specs = [
218
218
  {
@@ -4,7 +4,7 @@ import { SvelteMap, SvelteSet } from 'svelte/reactivity';
4
4
  * Unlike `slugify` from `@fuzdev/fuz_util/path.js` which lowercases,
5
5
  * this keeps the original casing so API declarations like `AsyncStatus`
6
6
  * and `async_status` produce distinct fragment IDs.
7
- * Used by the Tome documentation system for heading and section anchors.
7
+ * Used by the `Tome` documentation system for heading and section anchors.
8
8
  * @param str - the string to convert to a fragment
9
9
  * @returns a URL-safe fragment identifier with case preserved
10
10
  */
@@ -7,7 +7,7 @@ import { create_context } from './context_helpers.js';
7
7
  * Unlike `slugify` from `@fuzdev/fuz_util/path.js` which lowercases,
8
8
  * this keeps the original casing so API declarations like `AsyncStatus`
9
9
  * and `async_status` produce distinct fragment IDs.
10
- * Used by the Tome documentation system for heading and section anchors.
10
+ * Used by the `Tome` documentation system for heading and section anchors.
11
11
  * @param str - the string to convert to a fragment
12
12
  * @returns a URL-safe fragment identifier with case preserved
13
13
  */
@@ -9,10 +9,10 @@ export declare const parse_library_url_prefix: (value: unknown) => string;
9
9
  * Rich runtime representation of a library.
10
10
  *
11
11
  * Wraps `LibraryJson` with computed properties and provides the root
12
- * of the API documentation hierarchy: Library โ†’ modules โ†’ declarations
12
+ * of the API documentation hierarchy: `Library` โ†’ `Module` โ†’ `Declaration`.
13
13
  *
14
- * @see module.svelte.ts for Module class
15
- * @see declaration.svelte.ts for Declaration class
14
+ * @see `module.svelte.ts` for `Module` class
15
+ * @see `declaration.svelte.ts` for `Declaration` class
16
16
  */
17
17
  export declare class Library {
18
18
  readonly library_json: LibraryJson;
@@ -177,7 +177,7 @@ export declare class Library {
177
177
  */
178
178
  readonly org_url: string | null;
179
179
  /**
180
- * All modules as rich Module instances.
180
+ * All modules as rich `Module` instances.
181
181
  */
182
182
  readonly modules: Module[];
183
183
  /**
@@ -14,10 +14,10 @@ export const parse_library_url_prefix = (value) => {
14
14
  * Rich runtime representation of a library.
15
15
  *
16
16
  * Wraps `LibraryJson` with computed properties and provides the root
17
- * of the API documentation hierarchy: Library โ†’ modules โ†’ declarations
17
+ * of the API documentation hierarchy: `Library` โ†’ `Module` โ†’ `Declaration`.
18
18
  *
19
- * @see module.svelte.ts for Module class
20
- * @see declaration.svelte.ts for Declaration class
19
+ * @see `module.svelte.ts` for `Module` class
20
+ * @see `declaration.svelte.ts` for `Declaration` class
21
21
  */
22
22
  export class Library {
23
23
  library_json = $state.raw();
@@ -48,7 +48,7 @@ export class Library {
48
48
  : null
49
49
  : null);
50
50
  /**
51
- * All modules as rich Module instances.
51
+ * All modules as rich `Module` instances.
52
52
  */
53
53
  modules = $derived(this.source_json.modules
54
54
  ? this.source_json.modules.map((module_json) => new Module(this, module_json))
@@ -36,9 +36,9 @@
36
36
  * }
37
37
  * ```
38
38
  *
39
- * @see ts_helpers.ts for TypeScript-specific analysis
40
- * @see svelte_helpers.ts for Svelte component analysis
41
- * @see module_helpers.ts for path utilities and SourceFileInfo
39
+ * @see `ts_helpers.ts` for TypeScript-specific analysis
40
+ * @see `svelte_helpers.ts` for Svelte component analysis
41
+ * @see `module_helpers.ts` for path utilities and `SourceFileInfo`
42
42
  *
43
43
  * @module
44
44
  */
@@ -54,7 +54,7 @@ import type { AnalysisContext } from './analysis_context.js';
54
54
  export interface DeclarationAnalysis {
55
55
  /** The analyzed declaration metadata. */
56
56
  declaration: DeclarationJson;
57
- /** Whether the declaration is marked @nodocs (should be excluded from documentation). */
57
+ /** Whether the declaration is marked `@nodocs` (should be excluded from documentation). */
58
58
  nodocs: boolean;
59
59
  }
60
60
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"library_analysis.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_analysis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iCAAiC,CAAC;AAIrE,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,yCAAyC;IACzC,WAAW,EAAE,eAAe,CAAC;IAC7B,yFAAyF;IACzF,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,YAAY,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACzC,8EAA8E;IAC9E,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,gFAAgF;IAChF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,8EAA8E;IAC9E,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,0EAA0E;IAC1E,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB,GAClC,aAAa,cAAc,EAC3B,SAAS,EAAE,CAAC,OAAO,EACnB,SAAS,mBAAmB,EAC5B,KAAK,eAAe,EACpB,MAAM,MAAM,KACV,cAAc,GAAG,SAuCnB,CAAC"}
1
+ {"version":3,"file":"library_analysis.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_analysis.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AAEH,OAAO,EAAE,MAAM,YAAY,CAAC;AAC5B,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,yBAAyB,CAAC;AACpD,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,iCAAiC,CAAC;AAIrE,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAExB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,uBAAuB,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,yCAAyC;IACzC,WAAW,EAAE,eAAe,CAAC;IAC7B,2FAA2F;IAC3F,MAAM,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,eAAe,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,2CAA2C;IAC3C,IAAI,EAAE,MAAM,CAAC;IACb,0CAA0C;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,6EAA6E;IAC7E,YAAY,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACzC,8EAA8E;IAC9E,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,gFAAgF;IAChF,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,8EAA8E;IAC9E,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC5B,0EAA0E;IAC1E,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,sBAAsB,GAClC,aAAa,cAAc,EAC3B,SAAS,EAAE,CAAC,OAAO,EACnB,SAAS,mBAAmB,EAC5B,KAAK,eAAe,EACpB,MAAM,MAAM,KACV,cAAc,GAAG,SAuCnB,CAAC"}
@@ -36,9 +36,9 @@
36
36
  * }
37
37
  * ```
38
38
  *
39
- * @see ts_helpers.ts for TypeScript-specific analysis
40
- * @see svelte_helpers.ts for Svelte component analysis
41
- * @see module_helpers.ts for path utilities and SourceFileInfo
39
+ * @see `ts_helpers.ts` for TypeScript-specific analysis
40
+ * @see `svelte_helpers.ts` for Svelte component analysis
41
+ * @see `module_helpers.ts` for path utilities and `SourceFileInfo`
42
42
  *
43
43
  * @module
44
44
  */
@@ -7,9 +7,9 @@
7
7
  *
8
8
  * For build-tool agnostic usage, see `library_generate.ts`.
9
9
  *
10
- * @see library_generate.ts for the generic generation entry point
11
- * @see library_pipeline.ts for pipeline helpers
12
- * @see library_output.ts for output file generation
10
+ * @see `library_generate.ts` for the generic generation entry point
11
+ * @see `library_pipeline.ts` for pipeline helpers
12
+ * @see `library_output.ts` for output file generation
13
13
  *
14
14
  * @module
15
15
  */
@@ -34,6 +34,7 @@ export interface LibraryGenOptions {
34
34
  * Use `library_throw_on_duplicates` for strict flat namespace enforcement.
35
35
  *
36
36
  * @example
37
+ * ```ts
37
38
  * // Throw on duplicates (strict flat namespace)
38
39
  * library_gen({ on_duplicates: library_throw_on_duplicates });
39
40
  *
@@ -45,11 +46,12 @@ export interface LibraryGenOptions {
45
46
  * }
46
47
  * }
47
48
  * });
49
+ * ```
48
50
  */
49
51
  on_duplicates?: OnDuplicatesCallback;
50
52
  }
51
53
  /**
52
- * Convert Gro's Disknode to the build-tool agnostic SourceFileInfo interface.
54
+ * Convert Gro's `Disknode` to the build-tool agnostic `SourceFileInfo` interface.
53
55
  *
54
56
  * Use this when you want to analyze files using Gro's filer directly.
55
57
  *
@@ -57,7 +59,7 @@ export interface LibraryGenOptions {
57
59
  */
58
60
  export declare const source_file_from_disknode: (disknode: Disknode) => SourceFileInfo;
59
61
  /**
60
- * Collect source files from Gro disknodes, filtering BEFORE conversion to SourceFileInfo.
62
+ * Collect source files from Gro disknodes, filtering BEFORE conversion to `SourceFileInfo`.
61
63
  *
62
64
  * This avoids errors from files outside source directories (like test fixtures that may
63
65
  * have malformed paths or missing content). The filtering uses `module_is_source` which
@@ -72,12 +74,12 @@ export declare const library_collect_source_files_from_disknodes: (disknodes: It
72
74
  warn: (...args: Array<unknown>) => void;
73
75
  }) => Array<SourceFileInfo>;
74
76
  /**
75
- * Creates a Gen object for generating library metadata with full TypeScript analysis.
77
+ * Creates a `Gen` object for generating library metadata with full TypeScript analysis.
76
78
  *
77
79
  * This is the Gro-specific entry point. It handles:
78
80
  * - Reading files from Gro's filer
79
- * - Loading package.json via Gro utilities
80
- * - Returning output in Gro's Gen format
81
+ * - Loading `package.json` via Gro utilities
82
+ * - Returning output in Gro's `Gen` format
81
83
  *
82
84
  * For build-tool agnostic usage, use `library_generate` directly.
83
85
  *
@@ -1 +1 @@
1
- {"version":3,"file":"library_gen.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_gen.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,aAAa,CAAC;AAErC,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EAKxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAmB,KAAK,oBAAoB,EAAC,MAAM,uBAAuB,CAAC;AAElF,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5D;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,GAAI,UAAU,QAAQ,KAAG,cAY9D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2CAA2C,GACvD,WAAW,QAAQ,CAAC,QAAQ,CAAC,EAC7B,SAAS,mBAAmB,EAC5B,MAAM;IAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;CAAC,KACtF,KAAK,CAAC,cAAc,CA6BtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,iBAAiB,KAAG,GA2CzD,CAAC"}
1
+ {"version":3,"file":"library_gen.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_gen.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,aAAa,CAAC;AAErC,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,yBAAyB,CAAC;AAEtD,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EAKxB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAmB,KAAK,oBAAoB,EAAC,MAAM,uBAAuB,CAAC;AAElF,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IACjC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5D;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,GAAI,UAAU,QAAQ,KAAG,cAY9D,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,2CAA2C,GACvD,WAAW,QAAQ,CAAC,QAAQ,CAAC,EAC7B,SAAS,mBAAmB,EAC5B,MAAM;IAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAAC,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;CAAC,KACtF,KAAK,CAAC,cAAc,CA6BtB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,WAAW,GAAI,UAAU,iBAAiB,KAAG,GA2CzD,CAAC"}
@@ -7,9 +7,9 @@
7
7
  *
8
8
  * For build-tool agnostic usage, see `library_generate.ts`.
9
9
  *
10
- * @see library_generate.ts for the generic generation entry point
11
- * @see library_pipeline.ts for pipeline helpers
12
- * @see library_output.ts for output file generation
10
+ * @see `library_generate.ts` for the generic generation entry point
11
+ * @see `library_pipeline.ts` for pipeline helpers
12
+ * @see `library_output.ts` for output file generation
13
13
  *
14
14
  * @module
15
15
  */
@@ -17,7 +17,7 @@ import { package_json_load } from '@fuzdev/gro/package_json.js';
17
17
  import { module_create_source_options, module_validate_source_options, module_is_source, module_get_source_root, } from './module_helpers.js';
18
18
  import { library_generate } from './library_generate.js';
19
19
  /**
20
- * Convert Gro's Disknode to the build-tool agnostic SourceFileInfo interface.
20
+ * Convert Gro's `Disknode` to the build-tool agnostic `SourceFileInfo` interface.
21
21
  *
22
22
  * Use this when you want to analyze files using Gro's filer directly.
23
23
  *
@@ -35,7 +35,7 @@ export const source_file_from_disknode = (disknode) => {
35
35
  };
36
36
  };
37
37
  /**
38
- * Collect source files from Gro disknodes, filtering BEFORE conversion to SourceFileInfo.
38
+ * Collect source files from Gro disknodes, filtering BEFORE conversion to `SourceFileInfo`.
39
39
  *
40
40
  * This avoids errors from files outside source directories (like test fixtures that may
41
41
  * have malformed paths or missing content). The filtering uses `module_is_source` which
@@ -70,12 +70,12 @@ export const library_collect_source_files_from_disknodes = (disknodes, options,
70
70
  return source_files;
71
71
  };
72
72
  /**
73
- * Creates a Gen object for generating library metadata with full TypeScript analysis.
73
+ * Creates a `Gen` object for generating library metadata with full TypeScript analysis.
74
74
  *
75
75
  * This is the Gro-specific entry point. It handles:
76
76
  * - Reading files from Gro's filer
77
- * - Loading package.json via Gro utilities
78
- * - Returning output in Gro's Gen format
77
+ * - Loading `package.json` via Gro utilities
78
+ * - Returning output in Gro's `Gen` format
79
79
  *
80
80
  * For build-tool agnostic usage, use `library_generate` directly.
81
81
  *
@@ -12,9 +12,9 @@
12
12
  * - Dependency graphs
13
13
  * - Svelte component props
14
14
  *
15
- * For Gro integration, see `library_gen.ts` which wraps this with Gro's Gen interface.
15
+ * For Gro integration, see `library_gen.ts` which wraps this with Gro's `Gen` interface.
16
16
  *
17
- * @see @fuzdev/fuz_util/source_json.js for type definitions
17
+ * @see `@fuzdev/fuz_util/source_json.js` for type definitions
18
18
  * @see `library_analysis.ts` for the unified analysis entry point
19
19
  * @see `library_pipeline.ts` for pipeline helpers
20
20
  * @see `library_output.ts` for JSON/TS file generation
@@ -12,9 +12,9 @@
12
12
  * - Dependency graphs
13
13
  * - Svelte component props
14
14
  *
15
- * For Gro integration, see `library_gen.ts` which wraps this with Gro's Gen interface.
15
+ * For Gro integration, see `library_gen.ts` which wraps this with Gro's `Gen` interface.
16
16
  *
17
- * @see @fuzdev/fuz_util/source_json.js for type definitions
17
+ * @see `@fuzdev/fuz_util/source_json.js` for type definitions
18
18
  * @see `library_analysis.ts` for the unified analysis entry point
19
19
  * @see `library_pipeline.ts` for pipeline helpers
20
20
  * @see `library_output.ts` for JSON/TS file generation
@@ -48,9 +48,11 @@ export declare const url_package_logo: (homepage_url: string | null, logo_path?:
48
48
  * @returns root-relative URL starting with '/'
49
49
  *
50
50
  * @example
51
+ * ```ts
51
52
  * // Assuming page.url.origin is 'https://example.com'
52
53
  * url_to_root_relative('https://example.com/docs/api')
53
54
  * // => '/docs/api'
55
+ * ```
54
56
  */
55
57
  export declare const url_to_root_relative: (url: string, origin?: string) => string;
56
58
  //# sourceMappingURL=library_helpers.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"library_helpers.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAOH;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,kBAAkB,MAAM,KAAG,MACJ,CAAC;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GAAI,UAAU,MAAM,EAAE,kBAAkB,MAAM,KAAG,MACR,CAAC;AAE/E;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,MAAM,KAAG,MAA2C,CAAC;AAEjG;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC5B,cAAc,MAAM,GAAG,IAAI,EAC3B,YAAY,MAAM,KAChB,MAAM,GAAG,IAIX,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,oBAAoB,GAAI,KAAK,MAAM,EAAE,SAAQ,MAAwB,KAAG,MAcpF,CAAC"}
1
+ {"version":3,"file":"library_helpers.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_helpers.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAOH;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,kBAAkB,MAAM,KAAG,MACJ,CAAC;AAE5D;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,GAAI,UAAU,MAAM,EAAE,kBAAkB,MAAM,KAAG,MACR,CAAC;AAE/E;;;;;GAKG;AACH,eAAO,MAAM,cAAc,GAAI,aAAa,MAAM,KAAG,MAA2C,CAAC;AAEjG;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,GAC5B,cAAc,MAAM,GAAG,IAAI,EAC3B,YAAY,MAAM,KAChB,MAAM,GAAG,IAIX,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,GAAI,KAAK,MAAM,EAAE,SAAQ,MAAwB,KAAG,MAcpF,CAAC"}
@@ -56,9 +56,11 @@ export const url_package_logo = (homepage_url, logo_path) => {
56
56
  * @returns root-relative URL starting with '/'
57
57
  *
58
58
  * @example
59
+ * ```ts
59
60
  * // Assuming page.url.origin is 'https://example.com'
60
61
  * url_to_root_relative('https://example.com/docs/api')
61
62
  * // => '/docs/api'
63
+ * ```
62
64
  */
63
65
  export const url_to_root_relative = (url, origin = page.url.origin) => {
64
66
  const origin_with_slash = ensure_end(origin, '/');
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * Library output generation.
3
3
  *
4
- * Generates the library.json and library.ts files from analyzed metadata.
4
+ * Generates the `library.json` and `library.ts` files from analyzed metadata.
5
5
  *
6
- * @see library_generate.ts for the main generation entry point
7
- * @see library_pipeline.ts for pipeline orchestration functions
8
- * @see library_gen.ts for Gro-specific integration
6
+ * @see `library_generate.ts` for the main generation entry point
7
+ * @see `library_pipeline.ts` for pipeline orchestration functions
8
+ * @see `library_gen.ts` for Gro-specific integration
9
9
  *
10
10
  * @module
11
11
  */
@@ -16,13 +16,13 @@ import type { SourceJson } from '@fuzdev/fuz_util/source_json.js';
16
16
  * Contains both the JSON data and the TypeScript wrapper file.
17
17
  */
18
18
  export interface LibraryOutputResult {
19
- /** JSON content for library.json */
19
+ /** JSON content for `library.json`. */
20
20
  json_content: string;
21
- /** TypeScript wrapper content for library.ts */
21
+ /** TypeScript wrapper content for `library.ts`. */
22
22
  ts_content: string;
23
23
  }
24
24
  /**
25
- * Generate the library.json and library.ts file contents.
25
+ * Generate the `library.json` and `library.ts` file contents.
26
26
  * Parses at generation time so runtime only needs the pre-computed result.
27
27
  *
28
28
  * Returns JSON + .ts wrapper because:
@@ -1 +1 @@
1
- {"version":3,"file":"library_output.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_output.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAClE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAC;AAGhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,oCAAoC;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,UAAU,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,GACnC,cAAc,WAAW,EACzB,aAAa,UAAU,KACrB,mBAuBF,CAAC"}
1
+ {"version":3,"file":"library_output.d.ts","sourceRoot":"../src/lib/","sources":["../src/lib/library_output.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,kCAAkC,CAAC;AAClE,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAC;AAGhE;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,uBAAuB,GACnC,cAAc,WAAW,EACzB,aAAa,UAAU,KACrB,mBAuBF,CAAC"}
@@ -1,17 +1,17 @@
1
1
  /**
2
2
  * Library output generation.
3
3
  *
4
- * Generates the library.json and library.ts files from analyzed metadata.
4
+ * Generates the `library.json` and `library.ts` files from analyzed metadata.
5
5
  *
6
- * @see library_generate.ts for the main generation entry point
7
- * @see library_pipeline.ts for pipeline orchestration functions
8
- * @see library_gen.ts for Gro-specific integration
6
+ * @see `library_generate.ts` for the main generation entry point
7
+ * @see `library_pipeline.ts` for pipeline orchestration functions
8
+ * @see `library_gen.ts` for Gro-specific integration
9
9
  *
10
10
  * @module
11
11
  */
12
12
  import { library_json_parse } from '@fuzdev/fuz_util/library_json.js';
13
13
  /**
14
- * Generate the library.json and library.ts file contents.
14
+ * Generate the `library.json` and `library.ts` file contents.
15
15
  * Parses at generation time so runtime only needs the pre-computed result.
16
16
  *
17
17
  * Returns JSON + .ts wrapper because: