npm - @storm-software/tsdoc - Versions diffs - 0.3.3 → 0.3.5 - Mend

@storm-software/tsdoc 0.3.3 → 0.3.5

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 (8) hide show

package/README.md CHANGED Viewed

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
-[![Version](https://img.shields.io/badge/version-0.3.1-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)
+[![Version](https://img.shields.io/badge/version-0.3.4-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)
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->

package/config/base.json CHANGED Viewed

@@ -7,7 +7,7 @@
       "allowMultiple": true
     },
     {
-      "tagName": "@label",
+      "tagName": "@title",
       "syntaxKind": "block"
     }
   ]

package/config/core.json CHANGED Viewed

@@ -1,261 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  "extends": ["./typedoc.json", "./api-extractor.json", "./base.json"],
-  "tagDefinitions": [
-    {
-      "tagName": "@alias",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@label",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@betaDocumentation",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@internalRemarks",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@preapproved",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@author",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@module",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@mergeModuleWith",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@type",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@typedef",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@callback",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@prop",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@property",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@group",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@groupDescription",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@disableGroups",
-      "syntaxKind": "modifier",
-      "allowMultiple": false
-    },
-    {
-      "tagName": "@category",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@categoryDescription",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@hidden",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@ignore",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@class",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@abstract",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@document",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@default",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@extends",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@augments",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@return",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@yields",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@enum",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@event",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@expand",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@preventExpand",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@expandType",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@inline",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@preventInline",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@inlineType",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@primaryExport",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@template",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@linkcode",
-      "syntaxKind": "inline",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@linkplain",
-      "syntaxKind": "inline",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@include",
-      "syntaxKind": "inline",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@includeCode",
-      "syntaxKind": "inline",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@private",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@protected",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@satisfies",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@since",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@license",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@import",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@overload",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@namespace",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@interface",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@function",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@showCategories",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@hideCategories",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@showGroups",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@hideGroups",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@hideconstructor",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@jsx",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@summary",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@useDeclaredType",
-      "syntaxKind": "modifier"
-    }
-  ]
+  "extends": ["./typedoc.json", "./api-extractor.json", "./base.json"]
 }

package/dist/index.cjs CHANGED Viewed

@@ -84,7 +84,7 @@ var base_default = {
       allowMultiple: true
     },
     {
-      tagName: "@label",
+      tagName: "@title",
       syntaxKind: "block"
     }
   ]
@@ -93,262 +93,7 @@ var base_default = {
 // src/core.json
 var core_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  extends: ["./typedoc.json", "./api-extractor.json", "./base.json"],
-  tagDefinitions: [
-    {
-      tagName: "@alias",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@label",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@betaDocumentation",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@internalRemarks",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@preapproved",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@author",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@module",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@mergeModuleWith",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@type",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@typedef",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@callback",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@prop",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@property",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@group",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@groupDescription",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@disableGroups",
-      syntaxKind: "modifier",
-      allowMultiple: false
-    },
-    {
-      tagName: "@category",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@categoryDescription",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@hidden",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@ignore",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@class",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@abstract",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@document",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@default",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@extends",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@augments",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@return",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@yields",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@enum",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@event",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@expand",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@preventExpand",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@expandType",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@inline",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@preventInline",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@inlineType",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@primaryExport",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@template",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@linkcode",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@linkplain",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@include",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@includeCode",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@private",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@protected",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@satisfies",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@since",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@license",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@import",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@overload",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@namespace",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@interface",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@function",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@showCategories",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideCategories",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@showGroups",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideGroups",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideconstructor",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@jsx",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@summary",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@useDeclaredType",
-      syntaxKind: "modifier"
-    }
-  ]
+  extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
 };
 // src/typedoc.json

package/dist/index.d.cts CHANGED Viewed

@@ -64,15 +64,6 @@ declare const configs: {
     core: {
         $schema: string;
         extends: string[];
-        tagDefinitions: ({
-            tagName: string;
-            syntaxKind: string;
-            allowMultiple: boolean;
-        } | {
-            tagName: string;
-            syntaxKind: string;
-            allowMultiple?: undefined;
-        })[];
     };
 };

package/dist/index.d.ts CHANGED Viewed

@@ -64,15 +64,6 @@ declare const configs: {
     core: {
         $schema: string;
         extends: string[];
-        tagDefinitions: ({
-            tagName: string;
-            syntaxKind: string;
-            allowMultiple: boolean;
-        } | {
-            tagName: string;
-            syntaxKind: string;
-            allowMultiple?: undefined;
-        })[];
     };
 };

package/dist/index.js CHANGED Viewed

@@ -57,7 +57,7 @@ var base_default = {
       allowMultiple: true
     },
     {
-      tagName: "@label",
+      tagName: "@title",
       syntaxKind: "block"
     }
   ]
@@ -66,262 +66,7 @@ var base_default = {
 // src/core.json
 var core_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  extends: ["./typedoc.json", "./api-extractor.json", "./base.json"],
-  tagDefinitions: [
-    {
-      tagName: "@alias",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@label",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@betaDocumentation",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@internalRemarks",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@preapproved",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@author",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@module",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@mergeModuleWith",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@type",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@typedef",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@callback",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@prop",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@property",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@group",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@groupDescription",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@disableGroups",
-      syntaxKind: "modifier",
-      allowMultiple: false
-    },
-    {
-      tagName: "@category",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@categoryDescription",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@hidden",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@ignore",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@class",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@abstract",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@document",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@default",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@extends",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@augments",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@return",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@yields",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@enum",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@event",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@expand",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@preventExpand",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@expandType",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@inline",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@preventInline",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@inlineType",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@primaryExport",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@template",
-      syntaxKind: "block",
-      allowMultiple: true
-    },
-    {
-      tagName: "@linkcode",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@linkplain",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@include",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@includeCode",
-      syntaxKind: "inline",
-      allowMultiple: true
-    },
-    {
-      tagName: "@private",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@protected",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@satisfies",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@since",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@license",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@import",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@overload",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@namespace",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@interface",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@function",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@showCategories",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideCategories",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@showGroups",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideGroups",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@hideconstructor",
-      syntaxKind: "modifier"
-    },
-    {
-      tagName: "@jsx",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@summary",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@useDeclaredType",
-      syntaxKind: "modifier"
-    }
-  ]
+  extends: ["./typedoc.json", "./api-extractor.json", "./base.json"]
 };
 // src/typedoc.json

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/tsdoc",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "type": "module",
   "description": "This package contains shared TSDoc configurations used in Storm Software projects.",
   "repository": {