@storm-software/tsdoc 0.4.13 → 0.5.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/config/callouts.json +25 -0
- package/config/core.json +1 -21
- package/config/recommended.json +4 -0
- package/dist/index.cjs +36 -16
- package/dist/index.d.cts +19 -6
- package/dist/index.d.ts +19 -6
- package/dist/index.js +36 -16
- package/package.json +4 -2
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
3
|
+
"tagDefinitions": [
|
|
4
|
+
{
|
|
5
|
+
"tagName": "@important",
|
|
6
|
+
"syntaxKind": "block",
|
|
7
|
+
"allowMultiple": true
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
"tagName": "@danger",
|
|
11
|
+
"syntaxKind": "block",
|
|
12
|
+
"allowMultiple": true
|
|
13
|
+
},
|
|
14
|
+
{
|
|
15
|
+
"tagName": "@warning",
|
|
16
|
+
"syntaxKind": "block",
|
|
17
|
+
"allowMultiple": true
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"tagName": "@info",
|
|
21
|
+
"syntaxKind": "block",
|
|
22
|
+
"allowMultiple": true
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
}
|
package/config/core.json
CHANGED
|
@@ -1,28 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
3
|
+
"extends": ["./base.json", "./api-extractor.json", "./typedoc.json"],
|
|
3
4
|
"noStandardTags": false,
|
|
4
5
|
"tagDefinitions": [
|
|
5
|
-
{
|
|
6
|
-
"tagName": "@alias",
|
|
7
|
-
"syntaxKind": "block",
|
|
8
|
-
"allowMultiple": true
|
|
9
|
-
},
|
|
10
|
-
{
|
|
11
|
-
"tagName": "@title",
|
|
12
|
-
"syntaxKind": "block"
|
|
13
|
-
},
|
|
14
|
-
{
|
|
15
|
-
"tagName": "@betaDocumentation",
|
|
16
|
-
"syntaxKind": "modifier"
|
|
17
|
-
},
|
|
18
|
-
{
|
|
19
|
-
"tagName": "@internalRemarks",
|
|
20
|
-
"syntaxKind": "block"
|
|
21
|
-
},
|
|
22
|
-
{
|
|
23
|
-
"tagName": "@preapproved",
|
|
24
|
-
"syntaxKind": "modifier"
|
|
25
|
-
},
|
|
26
6
|
{
|
|
27
7
|
"tagName": "@author",
|
|
28
8
|
"syntaxKind": "block"
|
package/dist/index.cjs
CHANGED
|
@@ -60,32 +60,39 @@ var base_default = {
|
|
|
60
60
|
]
|
|
61
61
|
};
|
|
62
62
|
|
|
63
|
-
// src/
|
|
64
|
-
var
|
|
63
|
+
// src/callouts.json
|
|
64
|
+
var callouts_default = {
|
|
65
65
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
66
|
-
noStandardTags: false,
|
|
67
66
|
tagDefinitions: [
|
|
68
67
|
{
|
|
69
|
-
tagName: "@
|
|
68
|
+
tagName: "@important",
|
|
70
69
|
syntaxKind: "block",
|
|
71
70
|
allowMultiple: true
|
|
72
71
|
},
|
|
73
72
|
{
|
|
74
|
-
tagName: "@
|
|
75
|
-
syntaxKind: "block"
|
|
76
|
-
|
|
77
|
-
{
|
|
78
|
-
tagName: "@betaDocumentation",
|
|
79
|
-
syntaxKind: "modifier"
|
|
73
|
+
tagName: "@danger",
|
|
74
|
+
syntaxKind: "block",
|
|
75
|
+
allowMultiple: true
|
|
80
76
|
},
|
|
81
77
|
{
|
|
82
|
-
tagName: "@
|
|
83
|
-
syntaxKind: "block"
|
|
78
|
+
tagName: "@warning",
|
|
79
|
+
syntaxKind: "block",
|
|
80
|
+
allowMultiple: true
|
|
84
81
|
},
|
|
85
82
|
{
|
|
86
|
-
tagName: "@
|
|
87
|
-
syntaxKind: "
|
|
88
|
-
|
|
83
|
+
tagName: "@info",
|
|
84
|
+
syntaxKind: "block",
|
|
85
|
+
allowMultiple: true
|
|
86
|
+
}
|
|
87
|
+
]
|
|
88
|
+
};
|
|
89
|
+
|
|
90
|
+
// src/core.json
|
|
91
|
+
var core_default = {
|
|
92
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
93
|
+
extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
|
|
94
|
+
noStandardTags: false,
|
|
95
|
+
tagDefinitions: [
|
|
89
96
|
{
|
|
90
97
|
tagName: "@author",
|
|
91
98
|
syntaxKind: "block"
|
|
@@ -321,6 +328,12 @@ var core_default = {
|
|
|
321
328
|
]
|
|
322
329
|
};
|
|
323
330
|
|
|
331
|
+
// src/recommended.json
|
|
332
|
+
var recommended_default = {
|
|
333
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
334
|
+
extends: ["./core.json", "./callouts.json"]
|
|
335
|
+
};
|
|
336
|
+
|
|
324
337
|
// src/typedoc.json
|
|
325
338
|
var typedoc_default = {
|
|
326
339
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
@@ -562,7 +575,14 @@ var typedoc_default = {
|
|
|
562
575
|
};
|
|
563
576
|
|
|
564
577
|
// src/index.ts
|
|
565
|
-
var configs = {
|
|
578
|
+
var configs = {
|
|
579
|
+
base: base_default,
|
|
580
|
+
typedoc: typedoc_default,
|
|
581
|
+
apiExtractor: api_extractor_default,
|
|
582
|
+
core: core_default,
|
|
583
|
+
callouts: callouts_default,
|
|
584
|
+
recommended: recommended_default
|
|
585
|
+
};
|
|
566
586
|
var index_default = configs;
|
|
567
587
|
// Annotate the CommonJS export names for ESM import in node:
|
|
568
588
|
0 && (module.exports = {
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
declare const configs: {
|
|
2
|
-
base: {
|
|
2
|
+
readonly base: {
|
|
3
3
|
$schema: string;
|
|
4
4
|
tagDefinitions: ({
|
|
5
5
|
tagName: string;
|
|
@@ -11,7 +11,7 @@ declare const configs: {
|
|
|
11
11
|
allowMultiple?: undefined;
|
|
12
12
|
})[];
|
|
13
13
|
};
|
|
14
|
-
typedoc: {
|
|
14
|
+
readonly typedoc: {
|
|
15
15
|
$schema: string;
|
|
16
16
|
noStandardTags: boolean;
|
|
17
17
|
tagDefinitions: ({
|
|
@@ -24,26 +24,39 @@ declare const configs: {
|
|
|
24
24
|
allowMultiple: boolean;
|
|
25
25
|
})[];
|
|
26
26
|
};
|
|
27
|
-
apiExtractor: {
|
|
27
|
+
readonly apiExtractor: {
|
|
28
28
|
$schema: string;
|
|
29
29
|
tagDefinitions: {
|
|
30
30
|
tagName: string;
|
|
31
31
|
syntaxKind: string;
|
|
32
32
|
}[];
|
|
33
33
|
};
|
|
34
|
-
core: {
|
|
34
|
+
readonly core: {
|
|
35
35
|
$schema: string;
|
|
36
|
+
extends: string[];
|
|
36
37
|
noStandardTags: boolean;
|
|
37
38
|
tagDefinitions: ({
|
|
38
39
|
tagName: string;
|
|
39
40
|
syntaxKind: string;
|
|
40
|
-
allowMultiple
|
|
41
|
+
allowMultiple?: undefined;
|
|
41
42
|
} | {
|
|
42
43
|
tagName: string;
|
|
43
44
|
syntaxKind: string;
|
|
44
|
-
allowMultiple
|
|
45
|
+
allowMultiple: boolean;
|
|
45
46
|
})[];
|
|
46
47
|
};
|
|
48
|
+
readonly callouts: {
|
|
49
|
+
$schema: string;
|
|
50
|
+
tagDefinitions: {
|
|
51
|
+
tagName: string;
|
|
52
|
+
syntaxKind: string;
|
|
53
|
+
allowMultiple: boolean;
|
|
54
|
+
}[];
|
|
55
|
+
};
|
|
56
|
+
readonly recommended: {
|
|
57
|
+
$schema: string;
|
|
58
|
+
extends: string[];
|
|
59
|
+
};
|
|
47
60
|
};
|
|
48
61
|
|
|
49
62
|
export { configs, configs as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
declare const configs: {
|
|
2
|
-
base: {
|
|
2
|
+
readonly base: {
|
|
3
3
|
$schema: string;
|
|
4
4
|
tagDefinitions: ({
|
|
5
5
|
tagName: string;
|
|
@@ -11,7 +11,7 @@ declare const configs: {
|
|
|
11
11
|
allowMultiple?: undefined;
|
|
12
12
|
})[];
|
|
13
13
|
};
|
|
14
|
-
typedoc: {
|
|
14
|
+
readonly typedoc: {
|
|
15
15
|
$schema: string;
|
|
16
16
|
noStandardTags: boolean;
|
|
17
17
|
tagDefinitions: ({
|
|
@@ -24,26 +24,39 @@ declare const configs: {
|
|
|
24
24
|
allowMultiple: boolean;
|
|
25
25
|
})[];
|
|
26
26
|
};
|
|
27
|
-
apiExtractor: {
|
|
27
|
+
readonly apiExtractor: {
|
|
28
28
|
$schema: string;
|
|
29
29
|
tagDefinitions: {
|
|
30
30
|
tagName: string;
|
|
31
31
|
syntaxKind: string;
|
|
32
32
|
}[];
|
|
33
33
|
};
|
|
34
|
-
core: {
|
|
34
|
+
readonly core: {
|
|
35
35
|
$schema: string;
|
|
36
|
+
extends: string[];
|
|
36
37
|
noStandardTags: boolean;
|
|
37
38
|
tagDefinitions: ({
|
|
38
39
|
tagName: string;
|
|
39
40
|
syntaxKind: string;
|
|
40
|
-
allowMultiple
|
|
41
|
+
allowMultiple?: undefined;
|
|
41
42
|
} | {
|
|
42
43
|
tagName: string;
|
|
43
44
|
syntaxKind: string;
|
|
44
|
-
allowMultiple
|
|
45
|
+
allowMultiple: boolean;
|
|
45
46
|
})[];
|
|
46
47
|
};
|
|
48
|
+
readonly callouts: {
|
|
49
|
+
$schema: string;
|
|
50
|
+
tagDefinitions: {
|
|
51
|
+
tagName: string;
|
|
52
|
+
syntaxKind: string;
|
|
53
|
+
allowMultiple: boolean;
|
|
54
|
+
}[];
|
|
55
|
+
};
|
|
56
|
+
readonly recommended: {
|
|
57
|
+
$schema: string;
|
|
58
|
+
extends: string[];
|
|
59
|
+
};
|
|
47
60
|
};
|
|
48
61
|
|
|
49
62
|
export { configs, configs as default };
|
package/dist/index.js
CHANGED
|
@@ -33,32 +33,39 @@ var base_default = {
|
|
|
33
33
|
]
|
|
34
34
|
};
|
|
35
35
|
|
|
36
|
-
// src/
|
|
37
|
-
var
|
|
36
|
+
// src/callouts.json
|
|
37
|
+
var callouts_default = {
|
|
38
38
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
39
|
-
noStandardTags: false,
|
|
40
39
|
tagDefinitions: [
|
|
41
40
|
{
|
|
42
|
-
tagName: "@
|
|
41
|
+
tagName: "@important",
|
|
43
42
|
syntaxKind: "block",
|
|
44
43
|
allowMultiple: true
|
|
45
44
|
},
|
|
46
45
|
{
|
|
47
|
-
tagName: "@
|
|
48
|
-
syntaxKind: "block"
|
|
49
|
-
|
|
50
|
-
{
|
|
51
|
-
tagName: "@betaDocumentation",
|
|
52
|
-
syntaxKind: "modifier"
|
|
46
|
+
tagName: "@danger",
|
|
47
|
+
syntaxKind: "block",
|
|
48
|
+
allowMultiple: true
|
|
53
49
|
},
|
|
54
50
|
{
|
|
55
|
-
tagName: "@
|
|
56
|
-
syntaxKind: "block"
|
|
51
|
+
tagName: "@warning",
|
|
52
|
+
syntaxKind: "block",
|
|
53
|
+
allowMultiple: true
|
|
57
54
|
},
|
|
58
55
|
{
|
|
59
|
-
tagName: "@
|
|
60
|
-
syntaxKind: "
|
|
61
|
-
|
|
56
|
+
tagName: "@info",
|
|
57
|
+
syntaxKind: "block",
|
|
58
|
+
allowMultiple: true
|
|
59
|
+
}
|
|
60
|
+
]
|
|
61
|
+
};
|
|
62
|
+
|
|
63
|
+
// src/core.json
|
|
64
|
+
var core_default = {
|
|
65
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
66
|
+
extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
|
|
67
|
+
noStandardTags: false,
|
|
68
|
+
tagDefinitions: [
|
|
62
69
|
{
|
|
63
70
|
tagName: "@author",
|
|
64
71
|
syntaxKind: "block"
|
|
@@ -294,6 +301,12 @@ var core_default = {
|
|
|
294
301
|
]
|
|
295
302
|
};
|
|
296
303
|
|
|
304
|
+
// src/recommended.json
|
|
305
|
+
var recommended_default = {
|
|
306
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
307
|
+
extends: ["./core.json", "./callouts.json"]
|
|
308
|
+
};
|
|
309
|
+
|
|
297
310
|
// src/typedoc.json
|
|
298
311
|
var typedoc_default = {
|
|
299
312
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
@@ -535,7 +548,14 @@ var typedoc_default = {
|
|
|
535
548
|
};
|
|
536
549
|
|
|
537
550
|
// src/index.ts
|
|
538
|
-
var configs = {
|
|
551
|
+
var configs = {
|
|
552
|
+
base: base_default,
|
|
553
|
+
typedoc: typedoc_default,
|
|
554
|
+
apiExtractor: api_extractor_default,
|
|
555
|
+
core: core_default,
|
|
556
|
+
callouts: callouts_default,
|
|
557
|
+
recommended: recommended_default
|
|
558
|
+
};
|
|
539
559
|
var index_default = configs;
|
|
540
560
|
export {
|
|
541
561
|
configs,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-software/tsdoc",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "This package contains shared TSDoc configurations used in Storm Software projects.",
|
|
6
6
|
"repository": {
|
|
@@ -48,6 +48,8 @@
|
|
|
48
48
|
"./typedoc.json": "./config/typedoc.json",
|
|
49
49
|
"./api-extractor.json": "./config/api-extractor.json",
|
|
50
50
|
"./core.json": "./config/core.json",
|
|
51
|
+
"./callouts.json": "./config/callouts.json",
|
|
52
|
+
"./recommended.json": "./config/recommended.json",
|
|
51
53
|
"./index": {
|
|
52
54
|
"import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
|
|
53
55
|
"require": {
|
|
@@ -85,5 +87,5 @@
|
|
|
85
87
|
},
|
|
86
88
|
"publishConfig": { "access": "public" },
|
|
87
89
|
"sideEffects": false,
|
|
88
|
-
"gitHead": "
|
|
90
|
+
"gitHead": "4065888c60c591190a9ae9d2ed2075ffca86b31c"
|
|
89
91
|
}
|