npm - @storm-software/tsdoc - Versions diffs - 0.4.12 → 0.5.0 - Mend

@storm-software/tsdoc 0.4.12 → 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.

Files changed (9) 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.4.11-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.4.12-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/callouts.json ADDED Viewed

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "tagDefinitions": [
+    {
+      "tagName": "@important",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@danger",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@warning",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    },
+    {
+      "tagName": "@info",
+      "syntaxKind": "block",
+      "allowMultiple": true
+    }
+  ]
+}

package/config/core.json CHANGED Viewed

@@ -1,28 +1,8 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["./base.json", "./api-extractor.json", "./typedoc.json"],
   "noStandardTags": false,
   "tagDefinitions": [
-    {
-      "tagName": "@alias",
-      "syntaxKind": "block",
-      "allowMultiple": true
-    },
-    {
-      "tagName": "@title",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@betaDocumentation",
-      "syntaxKind": "modifier"
-    },
-    {
-      "tagName": "@internalRemarks",
-      "syntaxKind": "block"
-    },
-    {
-      "tagName": "@preapproved",
-      "syntaxKind": "modifier"
-    },
     {
       "tagName": "@author",
       "syntaxKind": "block"

package/config/recommended.json ADDED Viewed

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["./core.json", "./callouts.json"]
+}

package/dist/index.cjs CHANGED Viewed

@@ -60,32 +60,39 @@ var base_default = {
   ]
 };
-// src/core.json
-var core_default = {
+// src/callouts.json
+var callouts_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  noStandardTags: false,
   tagDefinitions: [
     {
-      tagName: "@alias",
+      tagName: "@important",
       syntaxKind: "block",
       allowMultiple: true
     },
     {
-      tagName: "@title",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@betaDocumentation",
-      syntaxKind: "modifier"
+      tagName: "@danger",
+      syntaxKind: "block",
+      allowMultiple: true
     },
     {
-      tagName: "@internalRemarks",
-      syntaxKind: "block"
+      tagName: "@warning",
+      syntaxKind: "block",
+      allowMultiple: true
     },
     {
-      tagName: "@preapproved",
-      syntaxKind: "modifier"
-    },
+      tagName: "@info",
+      syntaxKind: "block",
+      allowMultiple: true
+    }
+  ]
+};
+// src/core.json
+var core_default = {
+  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
+  noStandardTags: false,
+  tagDefinitions: [
     {
       tagName: "@author",
       syntaxKind: "block"
@@ -321,6 +328,12 @@ var core_default = {
   ]
 };
+// src/recommended.json
+var recommended_default = {
+  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  extends: ["./core.json", "./callouts.json"]
+};
 // src/typedoc.json
 var typedoc_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -562,7 +575,14 @@ var typedoc_default = {
 };
 // src/index.ts
-var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
+var configs = {
+  base: base_default,
+  typedoc: typedoc_default,
+  apiExtractor: api_extractor_default,
+  core: core_default,
+  callouts: callouts_default,
+  recommended: recommended_default
+};
 var index_default = configs;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/index.d.cts CHANGED Viewed

@@ -1,5 +1,5 @@
 declare const configs: {
-    base: {
+    readonly base: {
         $schema: string;
         tagDefinitions: ({
             tagName: string;
@@ -11,7 +11,7 @@ declare const configs: {
             allowMultiple?: undefined;
         })[];
     };
-    typedoc: {
+    readonly typedoc: {
         $schema: string;
         noStandardTags: boolean;
         tagDefinitions: ({
@@ -24,26 +24,39 @@ declare const configs: {
             allowMultiple: boolean;
         })[];
     };
-    apiExtractor: {
+    readonly apiExtractor: {
         $schema: string;
         tagDefinitions: {
             tagName: string;
             syntaxKind: string;
         }[];
     };
-    core: {
+    readonly core: {
         $schema: string;
+        extends: string[];
         noStandardTags: boolean;
         tagDefinitions: ({
             tagName: string;
             syntaxKind: string;
-            allowMultiple: boolean;
+            allowMultiple?: undefined;
         } | {
             tagName: string;
             syntaxKind: string;
-            allowMultiple?: undefined;
+            allowMultiple: boolean;
         })[];
     };
+    readonly callouts: {
+        $schema: string;
+        tagDefinitions: {
+            tagName: string;
+            syntaxKind: string;
+            allowMultiple: boolean;
+        }[];
+    };
+    readonly recommended: {
+        $schema: string;
+        extends: string[];
+    };
 };
 export { configs, configs as default };

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 declare const configs: {
-    base: {
+    readonly base: {
         $schema: string;
         tagDefinitions: ({
             tagName: string;
@@ -11,7 +11,7 @@ declare const configs: {
             allowMultiple?: undefined;
         })[];
     };
-    typedoc: {
+    readonly typedoc: {
         $schema: string;
         noStandardTags: boolean;
         tagDefinitions: ({
@@ -24,26 +24,39 @@ declare const configs: {
             allowMultiple: boolean;
         })[];
     };
-    apiExtractor: {
+    readonly apiExtractor: {
         $schema: string;
         tagDefinitions: {
             tagName: string;
             syntaxKind: string;
         }[];
     };
-    core: {
+    readonly core: {
         $schema: string;
+        extends: string[];
         noStandardTags: boolean;
         tagDefinitions: ({
             tagName: string;
             syntaxKind: string;
-            allowMultiple: boolean;
+            allowMultiple?: undefined;
         } | {
             tagName: string;
             syntaxKind: string;
-            allowMultiple?: undefined;
+            allowMultiple: boolean;
         })[];
     };
+    readonly callouts: {
+        $schema: string;
+        tagDefinitions: {
+            tagName: string;
+            syntaxKind: string;
+            allowMultiple: boolean;
+        }[];
+    };
+    readonly recommended: {
+        $schema: string;
+        extends: string[];
+    };
 };
 export { configs, configs as default };

package/dist/index.js CHANGED Viewed

@@ -33,32 +33,39 @@ var base_default = {
   ]
 };
-// src/core.json
-var core_default = {
+// src/callouts.json
+var callouts_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
-  noStandardTags: false,
   tagDefinitions: [
     {
-      tagName: "@alias",
+      tagName: "@important",
       syntaxKind: "block",
       allowMultiple: true
     },
     {
-      tagName: "@title",
-      syntaxKind: "block"
-    },
-    {
-      tagName: "@betaDocumentation",
-      syntaxKind: "modifier"
+      tagName: "@danger",
+      syntaxKind: "block",
+      allowMultiple: true
     },
     {
-      tagName: "@internalRemarks",
-      syntaxKind: "block"
+      tagName: "@warning",
+      syntaxKind: "block",
+      allowMultiple: true
     },
     {
-      tagName: "@preapproved",
-      syntaxKind: "modifier"
-    },
+      tagName: "@info",
+      syntaxKind: "block",
+      allowMultiple: true
+    }
+  ]
+};
+// src/core.json
+var core_default = {
+  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  extends: ["./base.json", "./api-extractor.json", "./typedoc.json"],
+  noStandardTags: false,
+  tagDefinitions: [
     {
       tagName: "@author",
       syntaxKind: "block"
@@ -294,6 +301,12 @@ var core_default = {
   ]
 };
+// src/recommended.json
+var recommended_default = {
+  $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  extends: ["./core.json", "./callouts.json"]
+};
 // src/typedoc.json
 var typedoc_default = {
   $schema: "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
@@ -535,7 +548,14 @@ var typedoc_default = {
 };
 // src/index.ts
-var configs = { base: base_default, typedoc: typedoc_default, apiExtractor: api_extractor_default, core: core_default };
+var configs = {
+  base: base_default,
+  typedoc: typedoc_default,
+  apiExtractor: api_extractor_default,
+  core: core_default,
+  callouts: callouts_default,
+  recommended: recommended_default
+};
 var index_default = configs;
 export {
   configs,

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/tsdoc",
-  "version": "0.4.12",
+  "version": "0.5.0",
   "type": "module",
   "description": "This package contains shared TSDoc configurations used in Storm Software projects.",
   "repository": {
@@ -48,6 +48,8 @@
     "./typedoc.json": "./config/typedoc.json",
     "./api-extractor.json": "./config/api-extractor.json",
     "./core.json": "./config/core.json",
+    "./callouts.json": "./config/callouts.json",
+    "./recommended.json": "./config/recommended.json",
     "./index": {
       "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
       "require": {
@@ -85,5 +87,5 @@
   },
   "publishConfig": { "access": "public" },
   "sideEffects": false,
-  "gitHead": "0a4f6bb876fd1fb34e8cecc243e38eb88deee463"
+  "gitHead": "4065888c60c591190a9ae9d2ed2075ffca86b31c"
 }