@hia-doc/cssdoc-runner 0.0.0-stage → 1.0.0-rc.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.
@@ -0,0 +1,817 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://mandolin.github.io/HIA-Documentation/schemas/hia-document-1.0.0.schema.json",
4
+ "type": "object",
5
+ "required": [
6
+ "schemaVersion",
7
+ "id",
8
+ "title",
9
+ "defaultLocale",
10
+ "locales",
11
+ "nodes",
12
+ "symbols"
13
+ ],
14
+ "additionalProperties": true,
15
+ "properties": {
16
+ "schemaVersion": {
17
+ "const": "1.0.0"
18
+ },
19
+ "id": {
20
+ "$ref": "#/$defs/nonEmptyString"
21
+ },
22
+ "title": {
23
+ "$ref": "#/$defs/nonEmptyString"
24
+ },
25
+ "defaultLocale": {
26
+ "$ref": "#/$defs/nonEmptyString"
27
+ },
28
+ "fallbackLocale": {
29
+ "$ref": "#/$defs/fallbackLocale"
30
+ },
31
+ "locales": {
32
+ "$ref": "#/$defs/localeList"
33
+ },
34
+ "nodes": {
35
+ "type": "array",
36
+ "items": {
37
+ "$ref": "#/$defs/node"
38
+ }
39
+ },
40
+ "symbols": {
41
+ "type": "array",
42
+ "items": {
43
+ "$ref": "#/$defs/symbol"
44
+ }
45
+ },
46
+ "diagnostics": {
47
+ "type": "array",
48
+ "items": {
49
+ "$ref": "#/$defs/diagnostic"
50
+ }
51
+ },
52
+ "metadata": {
53
+ "type": "object"
54
+ }
55
+ },
56
+ "$defs": {
57
+ "nonEmptyString": {
58
+ "type": "string",
59
+ "minLength": 1
60
+ },
61
+ "fallbackLocale": {
62
+ "anyOf": [
63
+ {
64
+ "$ref": "#/$defs/nonEmptyString"
65
+ },
66
+ {
67
+ "type": "array",
68
+ "minItems": 1,
69
+ "items": {
70
+ "$ref": "#/$defs/nonEmptyString"
71
+ }
72
+ }
73
+ ]
74
+ },
75
+ "localeList": {
76
+ "type": "array",
77
+ "minItems": 1,
78
+ "items": {
79
+ "$ref": "#/$defs/nonEmptyString"
80
+ }
81
+ },
82
+ "diagnostic": {
83
+ "type": "object",
84
+ "required": [
85
+ "code",
86
+ "message",
87
+ "severity"
88
+ ],
89
+ "additionalProperties": true,
90
+ "properties": {
91
+ "code": {
92
+ "$ref": "#/$defs/nonEmptyString"
93
+ },
94
+ "message": {
95
+ "$ref": "#/$defs/nonEmptyString"
96
+ },
97
+ "severity": {
98
+ "enum": [
99
+ "info",
100
+ "warning",
101
+ "error"
102
+ ]
103
+ },
104
+ "data": {
105
+ "type": "object"
106
+ },
107
+ "path": {
108
+ "$ref": "#/$defs/nonEmptyString"
109
+ },
110
+ "targetPath": {
111
+ "$ref": "#/$defs/nonEmptyString"
112
+ }
113
+ }
114
+ },
115
+ "node": {
116
+ "type": "object",
117
+ "required": [
118
+ "id",
119
+ "kind",
120
+ "title"
121
+ ],
122
+ "additionalProperties": true,
123
+ "properties": {
124
+ "id": {
125
+ "$ref": "#/$defs/nonEmptyString"
126
+ },
127
+ "kind": {
128
+ "$ref": "#/$defs/nonEmptyString"
129
+ },
130
+ "title": {
131
+ "$ref": "#/$defs/nonEmptyString"
132
+ },
133
+ "symbolIds": {
134
+ "type": "array",
135
+ "items": {
136
+ "$ref": "#/$defs/nonEmptyString"
137
+ }
138
+ },
139
+ "children": {
140
+ "type": "array",
141
+ "items": {
142
+ "$ref": "#/$defs/node"
143
+ }
144
+ }
145
+ }
146
+ },
147
+ "symbol": {
148
+ "type": "object",
149
+ "required": [
150
+ "id",
151
+ "name",
152
+ "kind"
153
+ ],
154
+ "additionalProperties": true,
155
+ "properties": {
156
+ "id": {
157
+ "$ref": "#/$defs/nonEmptyString"
158
+ },
159
+ "name": {
160
+ "$ref": "#/$defs/nonEmptyString"
161
+ },
162
+ "kind": {
163
+ "$ref": "#/$defs/nonEmptyString"
164
+ },
165
+ "longname": {
166
+ "$ref": "#/$defs/nonEmptyString"
167
+ },
168
+ "parentId": {
169
+ "$ref": "#/$defs/nonEmptyString"
170
+ },
171
+ "path": {
172
+ "type": "array",
173
+ "items": {
174
+ "$ref": "#/$defs/nonEmptyString"
175
+ }
176
+ },
177
+ "signature": {
178
+ "$ref": "#/$defs/nonEmptyString"
179
+ },
180
+ "summary": {
181
+ "type": "string"
182
+ },
183
+ "i18n": {
184
+ "$ref": "#/$defs/i18nModel"
185
+ },
186
+ "source": {
187
+ "$ref": "#/$defs/sourceMetadata"
188
+ },
189
+ "diagnostics": {
190
+ "type": "array",
191
+ "items": {
192
+ "$ref": "#/$defs/diagnostic"
193
+ }
194
+ },
195
+ "metadata": {
196
+ "type": "object"
197
+ }
198
+ }
199
+ },
200
+ "i18nModel": {
201
+ "type": "object",
202
+ "required": [
203
+ "enabled",
204
+ "model",
205
+ "modelVersion",
206
+ "defaultLocale",
207
+ "locales",
208
+ "fields"
209
+ ],
210
+ "additionalProperties": true,
211
+ "properties": {
212
+ "enabled": {
213
+ "type": "boolean"
214
+ },
215
+ "model": {
216
+ "const": "hia-text-i18n"
217
+ },
218
+ "modelVersion": {
219
+ "enum": [
220
+ "1.0.0",
221
+ "0.2.0"
222
+ ]
223
+ },
224
+ "defaultLocale": {
225
+ "$ref": "#/$defs/nonEmptyString"
226
+ },
227
+ "fallbackLocale": {
228
+ "$ref": "#/$defs/fallbackLocale"
229
+ },
230
+ "locales": {
231
+ "$ref": "#/$defs/localeList"
232
+ },
233
+ "mode": {
234
+ "$ref": "#/$defs/nonEmptyString"
235
+ },
236
+ "fields": {
237
+ "type": "object",
238
+ "additionalProperties": {
239
+ "$ref": "#/$defs/i18nField"
240
+ }
241
+ },
242
+ "resources": {
243
+ "type": "array",
244
+ "items": {
245
+ "$ref": "#/$defs/i18nResource"
246
+ }
247
+ },
248
+ "diagnostics": {
249
+ "type": "array",
250
+ "items": {
251
+ "$ref": "#/$defs/diagnostic"
252
+ }
253
+ }
254
+ }
255
+ },
256
+ "i18nResource": {
257
+ "type": "object",
258
+ "required": [
259
+ "path"
260
+ ],
261
+ "additionalProperties": true,
262
+ "properties": {
263
+ "kind": {
264
+ "$ref": "#/$defs/nonEmptyString"
265
+ },
266
+ "path": {
267
+ "$ref": "#/$defs/nonEmptyString"
268
+ },
269
+ "locale": {
270
+ "$ref": "#/$defs/nonEmptyString"
271
+ },
272
+ "format": {
273
+ "$ref": "#/$defs/nonEmptyString"
274
+ },
275
+ "fields": {
276
+ "type": "array",
277
+ "items": {
278
+ "$ref": "#/$defs/nonEmptyString"
279
+ }
280
+ }
281
+ }
282
+ },
283
+ "i18nField": {
284
+ "type": "object",
285
+ "required": [
286
+ "fieldPath",
287
+ "kind",
288
+ "defaultLocale",
289
+ "localizedText"
290
+ ],
291
+ "additionalProperties": true,
292
+ "properties": {
293
+ "fieldPath": {
294
+ "$ref": "#/$defs/nonEmptyString"
295
+ },
296
+ "kind": {
297
+ "$ref": "#/$defs/nonEmptyString"
298
+ },
299
+ "defaultLocale": {
300
+ "$ref": "#/$defs/nonEmptyString"
301
+ },
302
+ "key": {
303
+ "$ref": "#/$defs/nonEmptyString"
304
+ },
305
+ "path": {
306
+ "$ref": "#/$defs/nonEmptyString"
307
+ },
308
+ "defaultText": {
309
+ "type": "string"
310
+ },
311
+ "source": {
312
+ "$ref": "#/$defs/nonEmptyString"
313
+ },
314
+ "localizedText": {
315
+ "$ref": "#/$defs/localizedText"
316
+ },
317
+ "blocks": {
318
+ "type": "array",
319
+ "items": {
320
+ "$ref": "#/$defs/langBlock"
321
+ }
322
+ },
323
+ "segments": {
324
+ "type": "array",
325
+ "items": {
326
+ "$ref": "#/$defs/langInlineSegment"
327
+ }
328
+ },
329
+ "resolutions": {
330
+ "type": "object",
331
+ "additionalProperties": {
332
+ "$ref": "#/$defs/textResolution"
333
+ }
334
+ },
335
+ "missingLocales": {
336
+ "type": "array",
337
+ "items": {
338
+ "$ref": "#/$defs/nonEmptyString"
339
+ }
340
+ }
341
+ }
342
+ },
343
+ "localizedText": {
344
+ "type": "object",
345
+ "additionalProperties": {
346
+ "type": "string"
347
+ }
348
+ },
349
+ "langBlock": {
350
+ "type": "object",
351
+ "required": [
352
+ "kind",
353
+ "locale",
354
+ "fieldPath",
355
+ "text"
356
+ ],
357
+ "additionalProperties": true,
358
+ "properties": {
359
+ "kind": {
360
+ "const": "lang-block"
361
+ },
362
+ "locale": {
363
+ "$ref": "#/$defs/nonEmptyString"
364
+ },
365
+ "fieldPath": {
366
+ "$ref": "#/$defs/nonEmptyString"
367
+ },
368
+ "text": {
369
+ "type": "string"
370
+ },
371
+ "source": {
372
+ "$ref": "#/$defs/nonEmptyString"
373
+ },
374
+ "rangeInComment": {
375
+ "anyOf": [
376
+ {
377
+ "type": "null"
378
+ },
379
+ {
380
+ "$ref": "#/$defs/textRange"
381
+ }
382
+ ]
383
+ }
384
+ }
385
+ },
386
+ "langInlineSegment": {
387
+ "type": "object",
388
+ "required": [
389
+ "kind",
390
+ "id",
391
+ "fieldPath",
392
+ "raw",
393
+ "localized"
394
+ ],
395
+ "additionalProperties": true,
396
+ "properties": {
397
+ "kind": {
398
+ "const": "lang-inline"
399
+ },
400
+ "id": {
401
+ "$ref": "#/$defs/nonEmptyString"
402
+ },
403
+ "fieldPath": {
404
+ "$ref": "#/$defs/nonEmptyString"
405
+ },
406
+ "raw": {
407
+ "type": "string"
408
+ },
409
+ "localized": {
410
+ "$ref": "#/$defs/localizedText"
411
+ },
412
+ "key": {
413
+ "$ref": "#/$defs/nonEmptyString"
414
+ },
415
+ "path": {
416
+ "$ref": "#/$defs/nonEmptyString"
417
+ },
418
+ "rangeInField": {
419
+ "$ref": "#/$defs/textRange"
420
+ }
421
+ }
422
+ },
423
+ "textRange": {
424
+ "type": "object",
425
+ "required": [
426
+ "start",
427
+ "end"
428
+ ],
429
+ "additionalProperties": false,
430
+ "properties": {
431
+ "start": {
432
+ "type": "integer",
433
+ "minimum": 0,
434
+ "maximum": 9007199254740991
435
+ },
436
+ "end": {
437
+ "type": "integer",
438
+ "minimum": 0,
439
+ "maximum": 9007199254740991
440
+ }
441
+ }
442
+ },
443
+ "textResolution": {
444
+ "type": "object",
445
+ "required": [
446
+ "requestedLocale",
447
+ "resolvedLocale",
448
+ "fallbackChain",
449
+ "usedFallback",
450
+ "missing"
451
+ ],
452
+ "additionalProperties": true,
453
+ "properties": {
454
+ "requestedLocale": {
455
+ "$ref": "#/$defs/nonEmptyString"
456
+ },
457
+ "resolvedLocale": {
458
+ "type": "string"
459
+ },
460
+ "fallbackChain": {
461
+ "type": "array",
462
+ "items": {
463
+ "$ref": "#/$defs/nonEmptyString"
464
+ }
465
+ },
466
+ "usedFallback": {
467
+ "type": "boolean"
468
+ },
469
+ "missing": {
470
+ "type": "boolean"
471
+ },
472
+ "sourceKind": {
473
+ "$ref": "#/$defs/nonEmptyString"
474
+ },
475
+ "sourceLocale": {
476
+ "type": "string"
477
+ },
478
+ "source": {
479
+ "$ref": "#/$defs/nonEmptyString"
480
+ }
481
+ }
482
+ },
483
+ "sourcePosition": {
484
+ "type": "object",
485
+ "required": [
486
+ "line"
487
+ ],
488
+ "additionalProperties": true,
489
+ "properties": {
490
+ "line": {
491
+ "type": "integer",
492
+ "minimum": 1,
493
+ "maximum": 9007199254740991
494
+ },
495
+ "column": {
496
+ "type": "integer",
497
+ "minimum": 1,
498
+ "maximum": 9007199254740991
499
+ }
500
+ }
501
+ },
502
+ "sourceRange": {
503
+ "type": "object",
504
+ "required": [
505
+ "start",
506
+ "end"
507
+ ],
508
+ "additionalProperties": false,
509
+ "properties": {
510
+ "start": {
511
+ "$ref": "#/$defs/sourcePosition"
512
+ },
513
+ "end": {
514
+ "$ref": "#/$defs/sourcePosition"
515
+ }
516
+ }
517
+ },
518
+ "sourceLink": {
519
+ "type": "object",
520
+ "required": [
521
+ "enabled"
522
+ ],
523
+ "additionalProperties": true,
524
+ "properties": {
525
+ "enabled": {
526
+ "type": "boolean"
527
+ },
528
+ "fileUrl": {
529
+ "$ref": "#/$defs/nonEmptyString"
530
+ },
531
+ "lineUrl": {
532
+ "$ref": "#/$defs/nonEmptyString"
533
+ },
534
+ "openMode": {
535
+ "$ref": "#/$defs/nonEmptyString"
536
+ }
537
+ }
538
+ },
539
+ "sourcePreview": {
540
+ "type": "object",
541
+ "required": [
542
+ "enabled"
543
+ ],
544
+ "additionalProperties": true,
545
+ "properties": {
546
+ "enabled": {
547
+ "type": "boolean"
548
+ },
549
+ "defaultExpanded": {
550
+ "type": "boolean"
551
+ },
552
+ "content": {
553
+ "type": "string"
554
+ },
555
+ "language": {
556
+ "$ref": "#/$defs/nonEmptyString"
557
+ },
558
+ "range": {
559
+ "$ref": "#/$defs/sourceRange"
560
+ }
561
+ }
562
+ },
563
+ "sourceDefinedIn": {
564
+ "type": "object",
565
+ "required": [
566
+ "kind",
567
+ "relativePath",
568
+ "position"
569
+ ],
570
+ "additionalProperties": true,
571
+ "properties": {
572
+ "kind": {
573
+ "const": "defined-in"
574
+ },
575
+ "relativePath": {
576
+ "$ref": "#/$defs/nonEmptyString"
577
+ },
578
+ "language": {
579
+ "$ref": "#/$defs/nonEmptyString"
580
+ },
581
+ "position": {
582
+ "$ref": "#/$defs/sourcePosition"
583
+ },
584
+ "range": {
585
+ "$ref": "#/$defs/sourceRange"
586
+ },
587
+ "link": {
588
+ "$ref": "#/$defs/sourceLink"
589
+ }
590
+ }
591
+ },
592
+ "sourcePrimaryBlock": {
593
+ "type": "object",
594
+ "required": [
595
+ "kind",
596
+ "content",
597
+ "rangeSource",
598
+ "confidence"
599
+ ],
600
+ "additionalProperties": true,
601
+ "properties": {
602
+ "kind": {
603
+ "const": "primary-block"
604
+ },
605
+ "id": {
606
+ "$ref": "#/$defs/nonEmptyString"
607
+ },
608
+ "relativePath": {
609
+ "$ref": "#/$defs/nonEmptyString"
610
+ },
611
+ "language": {
612
+ "$ref": "#/$defs/nonEmptyString"
613
+ },
614
+ "range": {
615
+ "$ref": "#/$defs/sourceRange"
616
+ },
617
+ "content": {
618
+ "type": "string"
619
+ },
620
+ "rangeSource": {
621
+ "enum": [
622
+ "heuristic",
623
+ "parser",
624
+ "parser-js",
625
+ "jsdoc-meta",
626
+ "manual",
627
+ "unresolved"
628
+ ]
629
+ },
630
+ "confidence": {
631
+ "enum": [
632
+ "high",
633
+ "medium",
634
+ "low",
635
+ "none"
636
+ ]
637
+ },
638
+ "link": {
639
+ "$ref": "#/$defs/sourceLink"
640
+ },
641
+ "preview": {
642
+ "$ref": "#/$defs/sourcePreview"
643
+ },
644
+ "diagnostics": {
645
+ "type": "array",
646
+ "items": {
647
+ "$ref": "#/$defs/diagnostic"
648
+ }
649
+ }
650
+ }
651
+ },
652
+ "sourceReference": {
653
+ "type": "object",
654
+ "required": [
655
+ "kind",
656
+ "referenceKind",
657
+ "targetId",
658
+ "resolved"
659
+ ],
660
+ "additionalProperties": true,
661
+ "properties": {
662
+ "kind": {
663
+ "const": "source-reference"
664
+ },
665
+ "referenceKind": {
666
+ "$ref": "#/$defs/nonEmptyString"
667
+ },
668
+ "targetId": {
669
+ "$ref": "#/$defs/nonEmptyString"
670
+ },
671
+ "resolved": {
672
+ "type": "boolean"
673
+ },
674
+ "sourceNodeId": {
675
+ "$ref": "#/$defs/nonEmptyString"
676
+ },
677
+ "fieldPath": {
678
+ "$ref": "#/$defs/nonEmptyString"
679
+ },
680
+ "fragment": {
681
+ "$ref": "#/$defs/sourceFragment"
682
+ },
683
+ "diagnostics": {
684
+ "type": "array",
685
+ "items": {
686
+ "$ref": "#/$defs/diagnostic"
687
+ }
688
+ }
689
+ }
690
+ },
691
+ "sourceFragment": {
692
+ "type": "object",
693
+ "required": [
694
+ "kind",
695
+ "id",
696
+ "relativePath",
697
+ "range",
698
+ "content",
699
+ "rangeSource",
700
+ "confidence"
701
+ ],
702
+ "additionalProperties": true,
703
+ "properties": {
704
+ "kind": {
705
+ "const": "source-fragment"
706
+ },
707
+ "id": {
708
+ "$ref": "#/$defs/nonEmptyString"
709
+ },
710
+ "relativePath": {
711
+ "$ref": "#/$defs/nonEmptyString"
712
+ },
713
+ "language": {
714
+ "$ref": "#/$defs/nonEmptyString"
715
+ },
716
+ "range": {
717
+ "$ref": "#/$defs/sourceRange"
718
+ },
719
+ "content": {
720
+ "type": "string"
721
+ },
722
+ "rangeSource": {
723
+ "enum": [
724
+ "heuristic",
725
+ "parser",
726
+ "parser-js",
727
+ "jsdoc-meta",
728
+ "manual",
729
+ "unresolved"
730
+ ]
731
+ },
732
+ "confidence": {
733
+ "enum": [
734
+ "high",
735
+ "medium",
736
+ "low",
737
+ "none"
738
+ ]
739
+ },
740
+ "origin": {
741
+ "type": "object"
742
+ },
743
+ "link": {
744
+ "$ref": "#/$defs/sourceLink"
745
+ },
746
+ "preview": {
747
+ "$ref": "#/$defs/sourcePreview"
748
+ },
749
+ "diagnostics": {
750
+ "type": "array",
751
+ "items": {
752
+ "$ref": "#/$defs/diagnostic"
753
+ }
754
+ }
755
+ }
756
+ },
757
+ "sourceMetadata": {
758
+ "type": "object",
759
+ "required": [
760
+ "model",
761
+ "modelVersion",
762
+ "mode"
763
+ ],
764
+ "additionalProperties": true,
765
+ "properties": {
766
+ "model": {
767
+ "const": "hia-source"
768
+ },
769
+ "modelVersion": {
770
+ "enum": [
771
+ "1.0.0",
772
+ "0.2.0"
773
+ ]
774
+ },
775
+ "mode": {
776
+ "enum": [
777
+ "none",
778
+ "link",
779
+ "include",
780
+ "all"
781
+ ]
782
+ },
783
+ "definedIn": {
784
+ "$ref": "#/$defs/sourceDefinedIn"
785
+ },
786
+ "primaryBlock": {
787
+ "anyOf": [
788
+ {
789
+ "type": "null"
790
+ },
791
+ {
792
+ "$ref": "#/$defs/sourcePrimaryBlock"
793
+ }
794
+ ]
795
+ },
796
+ "references": {
797
+ "type": "array",
798
+ "items": {
799
+ "$ref": "#/$defs/sourceReference"
800
+ }
801
+ },
802
+ "fragments": {
803
+ "type": "array",
804
+ "items": {
805
+ "$ref": "#/$defs/sourceFragment"
806
+ }
807
+ },
808
+ "diagnostics": {
809
+ "type": "array",
810
+ "items": {
811
+ "$ref": "#/$defs/diagnostic"
812
+ }
813
+ }
814
+ }
815
+ }
816
+ }
817
+ }