@breadstone-tools/cem-plugins-custom-js-doc-tags 0.0.12-beta.0

package/CustomJsDocTagsPlugin.d.ts

@@ -0,0 +1,21 @@
+import type { IPlugin } from '@breadstone-tools/cem-plugin';
+export interface IOptions {
+    tags?: ICustomTag;
+    /** Hides logs produced by the plugin */
+    hideLogs?: boolean;
+    /** Prevents plugin from executing */
+    skip?: boolean;
+}
+export type ICustomTag = Record<string, {
+    mappedName?: string;
+    isArray?: boolean;
+}>;
+/**
+ * CEM Analyzer plugin to expand types in component metadata
+ *
+ * @param options Configuration options
+ *
+ * @public
+ */
+export declare function customJSDocTagsPlugin(options?: IOptions): IPlugin;
+//# sourceMappingURL=CustomJsDocTagsPlugin.d.ts.map

package/CustomJsDocTagsPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomJsDocTagsPlugin.d.ts","sourceRoot":"","sources":["../src/CustomJsDocTagsPlugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAuB,OAAO,EAAE,MAAM,8BAA8B,CAAC;AAKjF,MAAM,WAAW,QAAQ;IACrB,IAAI,CAAC,EAAE,UAAU,CAAC;IAElB,wCAAwC;IACxC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB,qCAAqC;IACrC,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC,CAAC;AAeP;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,GAAE,QAAuB,GAAG,OAAO,CAiF/E"}

package/CustomJsDocTagsPlugin.js

@@ -0,0 +1,90 @@
+"use strict";
+//#region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customJSDocTagsPlugin = customJSDocTagsPlugin;
+const comment_parser_1 = require("comment-parser");
+let userOptions = {
+    tags: {},
+};
+/**
+ * CEM Analyzer plugin to expand types in component metadata
+ *
+ * @param options Configuration options
+ *
+ * @public
+ */
+function customJSDocTagsPlugin(options = { tags: {} }) {
+    userOptions = options;
+    return {
+        name: 'CUSTOM-JSDOC-TAGS',
+        onAnalyze: (params) => {
+            // if (params.context.verbose) {
+            //     params.context.logger.logInfo('      [custom-jsdoc-tags] - Analyzing...');
+            // }
+            if (params.node.kind !== params.ts.SyntaxKind.ClassDeclaration) {
+                return;
+            }
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            const className = params.node.name.getText();
+            const component = params.moduleDoc.declarations?.find(declaration => declaration.name === className);
+            const customTags = Object.keys(userOptions.tags ?? {});
+            let customComments = '/**';
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            params.node.jsDoc?.forEach((jsDoc) => {
+                jsDoc?.tags?.forEach((tag) => {
+                    const tagName = tag.tagName.getText();
+                    if (customTags.includes(tagName)) {
+                        customComments += `\n * @${tagName} ${tag.comment}`;
+                    }
+                });
+            });
+            const parsed = (0, comment_parser_1.parse)(`${customComments}\n */`);
+            parsed[0]?.tags?.forEach(tagMeta => {
+                const tagOptions = userOptions.tags?.[tagMeta.tag];
+                if (!tagOptions) {
+                    return;
+                }
+                const propName = tagOptions.mappedName ?? tagMeta.tag;
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                const existingProp = component[propName];
+                const cemTag = {
+                    name: tagMeta.name === '-' ? '' : tagMeta.name,
+                    default: tagMeta.default,
+                    description: tagMeta.description.replace(/^\s?-/, '').trim(), // removes leading dash
+                    type: tagMeta.type ? { text: tagMeta.type } : undefined,
+                };
+                if (!existingProp && tagOptions.isArray) {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    component[propName] = [cemTag];
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                }
+                else if (Array.isArray(component[propName])) {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    component[propName].push(cemTag);
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                }
+                else if (existingProp && !Array.isArray(component[propName])) {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    component[propName] = [component[propName], cemTag];
+                }
+                else {
+                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                    // @ts-ignore
+                    component[propName] = cemTag;
+                }
+            });
+            // if (!options.hideLogs) {
+            //     Logger.instance().logInfo('[custom-jsdoc-tags] - Custom Elements Manifest updated.');
+            // }
+        },
+    };
+}
+//# sourceMappingURL=CustomJsDocTagsPlugin.js.map

package/CustomJsDocTagsPlugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CustomJsDocTagsPlugin.js","sourceRoot":"","sources":["../src/CustomJsDocTagsPlugin.ts"],"names":[],"mappings":";AAAA,iBAAiB;;AA0CjB,sDAiFC;AAxHD,mDAAuC;AA4BvC,IAAI,WAAW,GAAa;IACxB,IAAI,EAAE,EAAE;CACX,CAAC;AAEF;;;;;;GAMG;AACH,SAAgB,qBAAqB,CAAC,UAAoB,EAAE,IAAI,EAAE,EAAE,EAAE;IAClE,WAAW,GAAG,OAAO,CAAC;IAEtB,OAAO;QACH,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,CAAC,MAA2B,EAAE,EAAE;YACvC,gCAAgC;YAChC,iFAAiF;YACjF,IAAI;YAEJ,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC;gBAC7D,OAAO;YACX,CAAC;YAED,6DAA6D;YAC7D,aAAa;YACb,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7C,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CACjD,WAAW,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,SAAS,CAChD,CAAC;YACF,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;YACvD,IAAI,cAAc,GAAG,KAAK,CAAC;YAE3B,6DAA6D;YAC7D,aAAa;YACb,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,KAAU,EAAE,EAAE;gBACtC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,GAAQ,EAAE,EAAE;oBAC9B,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBAEtC,IAAI,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;wBAC/B,cAAc,IAAI,SAAS,OAAO,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;oBACxD,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,IAAA,sBAAK,EAAC,GAAG,cAAc,OAAO,CAAC,CAAC;YAC/C,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC/B,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBACnD,IAAI,CAAC,UAAU,EAAE,CAAC;oBACd,OAAO;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,UAAU,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;gBACtD,6DAA6D;gBAC7D,aAAa;gBACb,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACzC,MAAM,MAAM,GAAY;oBACpB,IAAI,EAAE,OAAO,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI;oBAC9C,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,WAAW,EAAE,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,EAAE,uBAAuB;oBACrF,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS;iBAC1D,CAAC;gBAEF,IAAI,CAAC,YAAY,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;oBACtC,6DAA6D;oBAC7D,aAAa;oBACb,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;oBAC/B,6DAA6D;oBAC7D,aAAa;gBACjB,CAAC;qBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;oBAC5C,6DAA6D;oBAC7D,aAAa;oBACb,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACjC,6DAA6D;oBAC7D,aAAa;gBACjB,CAAC;qBAAM,IAAI,YAAY,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;oBAC7D,6DAA6D;oBAC7D,aAAa;oBACb,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;gBACxD,CAAC;qBAAM,CAAC;oBACJ,6DAA6D;oBAC7D,aAAa;oBACb,SAAS,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC;gBACjC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,2BAA2B;YAC3B,4FAA4F;YAC5F,IAAI;QACR,CAAC;KACJ,CAAC;AACN,CAAC"}

package/Index.d.ts

@@ -0,0 +1,3 @@
+export type { IOptions } from './CustomJsDocTagsPlugin.js';
+export { customJSDocTagsPlugin } from './CustomJsDocTagsPlugin.js';
+//# sourceMappingURL=Index.d.ts.map

package/Index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Index.d.ts","sourceRoot":"","sources":["../src/Index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/Index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customJSDocTagsPlugin = void 0;
+var CustomJsDocTagsPlugin_js_1 = require("./CustomJsDocTagsPlugin.js");
+Object.defineProperty(exports, "customJSDocTagsPlugin", { enumerable: true, get: function () { return CustomJsDocTagsPlugin_js_1.customJSDocTagsPlugin; } });
+//# sourceMappingURL=Index.js.map

package/Index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Index.js","sourceRoot":"","sources":["../src/Index.ts"],"names":[],"mappings":";;;AACA,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA"}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Breadstone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@breadstone-tools/cem-plugins-custom-js-doc-tags",
+    "description": "Custom Elements Manifest Plugin for parsing custom JSDoc tags",
+    "version": "0.0.12-beta.0",
+    "license": "MIT",
+    "author": "andre.wehlert <awehlert@breadstone.de> (https://www.breadstone.de)",
+    "repository": {
+        "url": "git+ssh://git@github.com/RueDeRennes/mosaik.git"
+    },
+    "type": "commonjs",
+    "main": "./Index.js",
+    "commonjs": "./Index.js",
+    "module": "./Index.js",
+    "types": "./Index.d.ts",
+    "dependencies": {
+        "@breadstone-infrastructure/utilities": "^0.0.12-beta.0",
+        "@breadstone-tools/cem-infrastructure": "^0.0.12-beta.0",
+        "@breadstone-tools/cem-plugin": "^0.0.12-beta.0",
+        "comment-parser": "^1.4.1"
+    }
+}