@storm-software/tsdoc 0.1.7 → 0.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/README.md +1 -1
- package/config/api-extractor.json +47 -0
- package/config/base.json +0 -1
- package/config/core.json +4 -0
- package/dist/index.cjs +56 -2
- package/dist/index.d.cts +41 -1
- package/dist/index.d.ts +41 -1
- package/dist/index.js +56 -2
- package/package.json +6 -2
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
|
|
|
21
21
|
|
|
22
22
|
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
|
|
23
23
|
|
|
24
|
-
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
25
25
|
|
|
26
26
|
<!-- prettier-ignore-start -->
|
|
27
27
|
<!-- markdownlint-disable -->
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
3
|
+
"tagDefinitions": [
|
|
4
|
+
{
|
|
5
|
+
"tagName": "@betaDocumentation",
|
|
6
|
+
"syntaxKind": "modifier"
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
"tagName": "@internalRemarks",
|
|
10
|
+
"syntaxKind": "block"
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"tagName": "@preapproved",
|
|
14
|
+
"syntaxKind": "modifier"
|
|
15
|
+
}
|
|
16
|
+
],
|
|
17
|
+
"supportForTags": {
|
|
18
|
+
"@alpha": true,
|
|
19
|
+
"@beta": true,
|
|
20
|
+
"@defaultValue": true,
|
|
21
|
+
"@decorator": true,
|
|
22
|
+
"@deprecated": true,
|
|
23
|
+
"@eventProperty": true,
|
|
24
|
+
"@example": true,
|
|
25
|
+
"@experimental": true,
|
|
26
|
+
"@inheritDoc": true,
|
|
27
|
+
"@internal": true,
|
|
28
|
+
"@label": true,
|
|
29
|
+
"@link": true,
|
|
30
|
+
"@override": true,
|
|
31
|
+
"@packageDocumentation": true,
|
|
32
|
+
"@param": true,
|
|
33
|
+
"@privateRemarks": true,
|
|
34
|
+
"@public": true,
|
|
35
|
+
"@readonly": true,
|
|
36
|
+
"@remarks": true,
|
|
37
|
+
"@returns": true,
|
|
38
|
+
"@sealed": true,
|
|
39
|
+
"@see": true,
|
|
40
|
+
"@throws": true,
|
|
41
|
+
"@typeParam": true,
|
|
42
|
+
"@virtual": true,
|
|
43
|
+
"@betaDocumentation": true,
|
|
44
|
+
"@internalRemarks": true,
|
|
45
|
+
"@preapproved": true
|
|
46
|
+
}
|
|
47
|
+
}
|
package/config/base.json
CHANGED
package/config/core.json
ADDED
package/dist/index.cjs
CHANGED
|
@@ -25,10 +25,58 @@ __export(index_exports, {
|
|
|
25
25
|
});
|
|
26
26
|
module.exports = __toCommonJS(index_exports);
|
|
27
27
|
|
|
28
|
+
// src/api-extractor.json
|
|
29
|
+
var api_extractor_default = {
|
|
30
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
31
|
+
tagDefinitions: [
|
|
32
|
+
{
|
|
33
|
+
tagName: "@betaDocumentation",
|
|
34
|
+
syntaxKind: "modifier"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
tagName: "@internalRemarks",
|
|
38
|
+
syntaxKind: "block"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
tagName: "@preapproved",
|
|
42
|
+
syntaxKind: "modifier"
|
|
43
|
+
}
|
|
44
|
+
],
|
|
45
|
+
supportForTags: {
|
|
46
|
+
"@alpha": true,
|
|
47
|
+
"@beta": true,
|
|
48
|
+
"@defaultValue": true,
|
|
49
|
+
"@decorator": true,
|
|
50
|
+
"@deprecated": true,
|
|
51
|
+
"@eventProperty": true,
|
|
52
|
+
"@example": true,
|
|
53
|
+
"@experimental": true,
|
|
54
|
+
"@inheritDoc": true,
|
|
55
|
+
"@internal": true,
|
|
56
|
+
"@label": true,
|
|
57
|
+
"@link": true,
|
|
58
|
+
"@override": true,
|
|
59
|
+
"@packageDocumentation": true,
|
|
60
|
+
"@param": true,
|
|
61
|
+
"@privateRemarks": true,
|
|
62
|
+
"@public": true,
|
|
63
|
+
"@readonly": true,
|
|
64
|
+
"@remarks": true,
|
|
65
|
+
"@returns": true,
|
|
66
|
+
"@sealed": true,
|
|
67
|
+
"@see": true,
|
|
68
|
+
"@throws": true,
|
|
69
|
+
"@typeParam": true,
|
|
70
|
+
"@virtual": true,
|
|
71
|
+
"@betaDocumentation": true,
|
|
72
|
+
"@internalRemarks": true,
|
|
73
|
+
"@preapproved": true
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
|
|
28
77
|
// src/base.json
|
|
29
78
|
var base_default = {
|
|
30
79
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
31
|
-
extends: ["./typedoc.json"],
|
|
32
80
|
tagDefinitions: [
|
|
33
81
|
{
|
|
34
82
|
tagName: "@alias",
|
|
@@ -42,6 +90,12 @@ var base_default = {
|
|
|
42
90
|
]
|
|
43
91
|
};
|
|
44
92
|
|
|
93
|
+
// src/core.json
|
|
94
|
+
var core_default = {
|
|
95
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
96
|
+
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
|
|
97
|
+
};
|
|
98
|
+
|
|
45
99
|
// src/typedoc.json
|
|
46
100
|
var typedoc_default = {
|
|
47
101
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
@@ -283,7 +337,7 @@ var typedoc_default = {
|
|
|
283
337
|
};
|
|
284
338
|
|
|
285
339
|
// src/index.ts
|
|
286
|
-
var configs = { base: base_default, typedoc: typedoc_default };
|
|
340
|
+
var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
|
|
287
341
|
var index_default = configs;
|
|
288
342
|
// Annotate the CommonJS export names for ESM import in node:
|
|
289
343
|
0 && (module.exports = {
|
package/dist/index.d.cts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
declare const configs: {
|
|
2
2
|
base: {
|
|
3
3
|
$schema: string;
|
|
4
|
-
extends: string[];
|
|
5
4
|
tagDefinitions: ({
|
|
6
5
|
tagName: string;
|
|
7
6
|
syntaxKind: string;
|
|
@@ -25,6 +24,47 @@ declare const configs: {
|
|
|
25
24
|
allowMultiple: boolean;
|
|
26
25
|
})[];
|
|
27
26
|
};
|
|
27
|
+
apiExtractor: {
|
|
28
|
+
$schema: string;
|
|
29
|
+
tagDefinitions: {
|
|
30
|
+
tagName: string;
|
|
31
|
+
syntaxKind: string;
|
|
32
|
+
}[];
|
|
33
|
+
supportForTags: {
|
|
34
|
+
"@alpha": boolean;
|
|
35
|
+
"@beta": boolean;
|
|
36
|
+
"@defaultValue": boolean;
|
|
37
|
+
"@decorator": boolean;
|
|
38
|
+
"@deprecated": boolean;
|
|
39
|
+
"@eventProperty": boolean;
|
|
40
|
+
"@example": boolean;
|
|
41
|
+
"@experimental": boolean;
|
|
42
|
+
"@inheritDoc": boolean;
|
|
43
|
+
"@internal": boolean;
|
|
44
|
+
"@label": boolean;
|
|
45
|
+
"@link": boolean;
|
|
46
|
+
"@override": boolean;
|
|
47
|
+
"@packageDocumentation": boolean;
|
|
48
|
+
"@param": boolean;
|
|
49
|
+
"@privateRemarks": boolean;
|
|
50
|
+
"@public": boolean;
|
|
51
|
+
"@readonly": boolean;
|
|
52
|
+
"@remarks": boolean;
|
|
53
|
+
"@returns": boolean;
|
|
54
|
+
"@sealed": boolean;
|
|
55
|
+
"@see": boolean;
|
|
56
|
+
"@throws": boolean;
|
|
57
|
+
"@typeParam": boolean;
|
|
58
|
+
"@virtual": boolean;
|
|
59
|
+
"@betaDocumentation": boolean;
|
|
60
|
+
"@internalRemarks": boolean;
|
|
61
|
+
"@preapproved": boolean;
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
core: {
|
|
65
|
+
$schema: string;
|
|
66
|
+
extends: string[];
|
|
67
|
+
};
|
|
28
68
|
};
|
|
29
69
|
|
|
30
70
|
export { configs, configs as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
declare const configs: {
|
|
2
2
|
base: {
|
|
3
3
|
$schema: string;
|
|
4
|
-
extends: string[];
|
|
5
4
|
tagDefinitions: ({
|
|
6
5
|
tagName: string;
|
|
7
6
|
syntaxKind: string;
|
|
@@ -25,6 +24,47 @@ declare const configs: {
|
|
|
25
24
|
allowMultiple: boolean;
|
|
26
25
|
})[];
|
|
27
26
|
};
|
|
27
|
+
apiExtractor: {
|
|
28
|
+
$schema: string;
|
|
29
|
+
tagDefinitions: {
|
|
30
|
+
tagName: string;
|
|
31
|
+
syntaxKind: string;
|
|
32
|
+
}[];
|
|
33
|
+
supportForTags: {
|
|
34
|
+
"@alpha": boolean;
|
|
35
|
+
"@beta": boolean;
|
|
36
|
+
"@defaultValue": boolean;
|
|
37
|
+
"@decorator": boolean;
|
|
38
|
+
"@deprecated": boolean;
|
|
39
|
+
"@eventProperty": boolean;
|
|
40
|
+
"@example": boolean;
|
|
41
|
+
"@experimental": boolean;
|
|
42
|
+
"@inheritDoc": boolean;
|
|
43
|
+
"@internal": boolean;
|
|
44
|
+
"@label": boolean;
|
|
45
|
+
"@link": boolean;
|
|
46
|
+
"@override": boolean;
|
|
47
|
+
"@packageDocumentation": boolean;
|
|
48
|
+
"@param": boolean;
|
|
49
|
+
"@privateRemarks": boolean;
|
|
50
|
+
"@public": boolean;
|
|
51
|
+
"@readonly": boolean;
|
|
52
|
+
"@remarks": boolean;
|
|
53
|
+
"@returns": boolean;
|
|
54
|
+
"@sealed": boolean;
|
|
55
|
+
"@see": boolean;
|
|
56
|
+
"@throws": boolean;
|
|
57
|
+
"@typeParam": boolean;
|
|
58
|
+
"@virtual": boolean;
|
|
59
|
+
"@betaDocumentation": boolean;
|
|
60
|
+
"@internalRemarks": boolean;
|
|
61
|
+
"@preapproved": boolean;
|
|
62
|
+
};
|
|
63
|
+
};
|
|
64
|
+
core: {
|
|
65
|
+
$schema: string;
|
|
66
|
+
extends: string[];
|
|
67
|
+
};
|
|
28
68
|
};
|
|
29
69
|
|
|
30
70
|
export { configs, configs as default };
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,55 @@
|
|
|
1
|
+
// src/api-extractor.json
|
|
2
|
+
var api_extractor_default = {
|
|
3
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
4
|
+
tagDefinitions: [
|
|
5
|
+
{
|
|
6
|
+
tagName: "@betaDocumentation",
|
|
7
|
+
syntaxKind: "modifier"
|
|
8
|
+
},
|
|
9
|
+
{
|
|
10
|
+
tagName: "@internalRemarks",
|
|
11
|
+
syntaxKind: "block"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
tagName: "@preapproved",
|
|
15
|
+
syntaxKind: "modifier"
|
|
16
|
+
}
|
|
17
|
+
],
|
|
18
|
+
supportForTags: {
|
|
19
|
+
"@alpha": true,
|
|
20
|
+
"@beta": true,
|
|
21
|
+
"@defaultValue": true,
|
|
22
|
+
"@decorator": true,
|
|
23
|
+
"@deprecated": true,
|
|
24
|
+
"@eventProperty": true,
|
|
25
|
+
"@example": true,
|
|
26
|
+
"@experimental": true,
|
|
27
|
+
"@inheritDoc": true,
|
|
28
|
+
"@internal": true,
|
|
29
|
+
"@label": true,
|
|
30
|
+
"@link": true,
|
|
31
|
+
"@override": true,
|
|
32
|
+
"@packageDocumentation": true,
|
|
33
|
+
"@param": true,
|
|
34
|
+
"@privateRemarks": true,
|
|
35
|
+
"@public": true,
|
|
36
|
+
"@readonly": true,
|
|
37
|
+
"@remarks": true,
|
|
38
|
+
"@returns": true,
|
|
39
|
+
"@sealed": true,
|
|
40
|
+
"@see": true,
|
|
41
|
+
"@throws": true,
|
|
42
|
+
"@typeParam": true,
|
|
43
|
+
"@virtual": true,
|
|
44
|
+
"@betaDocumentation": true,
|
|
45
|
+
"@internalRemarks": true,
|
|
46
|
+
"@preapproved": true
|
|
47
|
+
}
|
|
48
|
+
};
|
|
49
|
+
|
|
1
50
|
// src/base.json
|
|
2
51
|
var base_default = {
|
|
3
52
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
4
|
-
extends: ["./typedoc.json"],
|
|
5
53
|
tagDefinitions: [
|
|
6
54
|
{
|
|
7
55
|
tagName: "@alias",
|
|
@@ -15,6 +63,12 @@ var base_default = {
|
|
|
15
63
|
]
|
|
16
64
|
};
|
|
17
65
|
|
|
66
|
+
// src/core.json
|
|
67
|
+
var core_default = {
|
|
68
|
+
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
69
|
+
extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
|
|
70
|
+
};
|
|
71
|
+
|
|
18
72
|
// src/typedoc.json
|
|
19
73
|
var typedoc_default = {
|
|
20
74
|
$schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
|
|
@@ -256,7 +310,7 @@ var typedoc_default = {
|
|
|
256
310
|
};
|
|
257
311
|
|
|
258
312
|
// src/index.ts
|
|
259
|
-
var configs = { base: base_default, typedoc: typedoc_default };
|
|
313
|
+
var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
|
|
260
314
|
var index_default = configs;
|
|
261
315
|
export {
|
|
262
316
|
configs,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-software/tsdoc",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "This package contains shared TSDoc configurations used in Storm Software projects.",
|
|
6
6
|
"repository": {
|
|
@@ -44,8 +44,10 @@
|
|
|
44
44
|
"module": "./dist/index.js",
|
|
45
45
|
"exports": {
|
|
46
46
|
"./package.json": "./package.json",
|
|
47
|
-
"./typedoc.json": "./config/typedoc.json",
|
|
48
47
|
"./base.json": "./config/base.json",
|
|
48
|
+
"./typedoc.json": "./config/typedoc.json",
|
|
49
|
+
"./api-extractor.json": "./config/api-extractor.json",
|
|
50
|
+
"./core.json": "./config/core.json",
|
|
49
51
|
"./index": {
|
|
50
52
|
"import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
|
|
51
53
|
"require": {
|
|
@@ -67,10 +69,12 @@
|
|
|
67
69
|
"files": ["config/**/*", "dist/**/*"],
|
|
68
70
|
"keywords": ["tsdoc", "typedoc", "storm", "storm-ops", "storm-software"],
|
|
69
71
|
"peerDependencies": {
|
|
72
|
+
"@microsoft/api-extractor": ">=7.52.0",
|
|
70
73
|
"@microsoft/tsdoc": ">=0.15.0",
|
|
71
74
|
"@microsoft/tsdoc-config": ">=0.17.0"
|
|
72
75
|
},
|
|
73
76
|
"peerDependenciesMeta": {
|
|
77
|
+
"@microsoft/api-extractor": { "optional": true },
|
|
74
78
|
"@microsoft/tsdoc": { "optional": true },
|
|
75
79
|
"@microsoft/tsdoc-config": { "optional": true }
|
|
76
80
|
},
|