@storm-software/tsdoc 0.2.0 → 0.3.1

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 (9) hide show
  1. package/README.md +1 -1
  2. package/config/api-extractor.json +17 -0
  3. package/config/base.json +0 -4
  4. package/config/core.json +4 -0
  5. package/dist/index.cjs +26 -5
  6. package/dist/index.d.cts +11 -1
  7. package/dist/index.d.ts +11 -1
  8. package/dist/index.js +26 -5
  9. package/package.json +4 -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
- [![Version](https://img.shields.io/badge/version-0.1.6-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
24
+ [![Version](https://img.shields.io/badge/version-0.2.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
25
25
 
26
26
  <!-- prettier-ignore-start -->
27
27
  <!-- markdownlint-disable -->
package/config/api-extractor.json ADDED
@@ -0,0 +1,17 @@
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
+ }
package/config/base.json CHANGED
@@ -1,9 +1,5 @@
1
1
  {
2
2
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
- "extends": [
4
- "./typedoc.json",
5
- "@microsoft/api-extractor/extends/tsdoc-config.json"
6
- ],
7
3
  "tagDefinitions": [
8
4
  {
9
5
  "tagName": "@alias",
package/config/core.json ADDED
@@ -0,0 +1,4 @@
1
+ {
2
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3
+ "extends": ["./typedoc.json", "./api-extractor.json", "./base.json"]
4
+ }
package/dist/index.cjs CHANGED
@@ -25,13 +25,28 @@ __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
+ };
46
+
28
47
  // src/base.json
29
48
  var base_default = {
30
49
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
31
- extends: [
32
- "./typedoc.json",
33
- "@microsoft/api-extractor/extends/tsdoc-config.json"
34
- ],
35
50
  tagDefinitions: [
36
51
  {
37
52
  tagName: "@alias",
@@ -45,6 +60,12 @@ var base_default = {
45
60
  ]
46
61
  };
47
62
 
63
+ // src/core.json
64
+ var core_default = {
65
+ $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
66
+ extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
67
+ };
68
+
48
69
  // src/typedoc.json
49
70
  var typedoc_default = {
50
71
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -286,7 +307,7 @@ var typedoc_default = {
286
307
  };
287
308
 
288
309
  // src/index.ts
289
- var configs = { base: base_default, typedoc: typedoc_default };
310
+ var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
290
311
  var index_default = configs;
291
312
  // Annotate the CommonJS export names for ESM import in node:
292
313
  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,17 @@ 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
+ };
34
+ core: {
35
+ $schema: string;
36
+ extends: string[];
37
+ };
28
38
  };
29
39
 
30
40
  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,17 @@ 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
+ };
34
+ core: {
35
+ $schema: string;
36
+ extends: string[];
37
+ };
28
38
  };
29
39
 
30
40
  export { configs, configs as default };
package/dist/index.js CHANGED
@@ -1,10 +1,25 @@
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
+ };
19
+
1
20
  // src/base.json
2
21
  var base_default = {
3
22
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
4
- extends: [
5
- "./typedoc.json",
6
- "@microsoft/api-extractor/extends/tsdoc-config.json"
7
- ],
8
23
  tagDefinitions: [
9
24
  {
10
25
  tagName: "@alias",
@@ -18,6 +33,12 @@ var base_default = {
18
33
  ]
19
34
  };
20
35
 
36
+ // src/core.json
37
+ var core_default = {
38
+ $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
39
+ extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
40
+ };
41
+
21
42
  // src/typedoc.json
22
43
  var typedoc_default = {
23
44
  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -259,7 +280,7 @@ var typedoc_default = {
259
280
  };
260
281
 
261
282
  // src/index.ts
262
- var configs = { base: base_default, typedoc: typedoc_default };
283
+ var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
263
284
  var index_default = configs;
264
285
  export {
265
286
  configs,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@storm-software/tsdoc",
3
- "version": "0.2.0",
3
+ "version": "0.3.1",
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": {