@breadstone-infrastructure/nx-tasks 0.0.12-beta.9 → 0.0.13

package/executors/lit-docs/JSDocChecker.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Interface representing the result of a JSDoc check.
+ */
+export interface IJSDocCheckerResult {
+    className: string;
+    missingTags: Array<'description' | 'name' | 'element' | 'category' | 'example' | 'public' | 'slot' | 'csspart' | 'fires' | 'cssprop' | 'dependency'>;
+    missingDetails: {
+        slot?: Array<string>;
+        csspart?: Array<string>;
+        fires?: Array<string>;
+        cssprop?: Array<string>;
+        dependency?: Array<string>;
+    };
+    orderDetails: {
+        currentOrder: Array<string>;
+        correctOrder: Array<string>;
+        missingTags: Array<string>;
+    };
+}
+/**
+ * JSDocChecker is responsible for verifying the completeness of JSDoc comments
+ * on TypeScript classes decorated with @Component.
+ */
+export declare class JSDocChecker {
+    private readonly _correctOrder;
+    private readonly _filePath;
+    /**
+     * Initializes a new instance of the JSDocChecker class.
+     * @param filePath The path to the TypeScript file to be checked.
+     */
+    constructor(filePath: string);
+    /**
+     * Validates the JSDoc comments in the TypeScript file against the specified schema.
+     * Ensures that all required tags are present and optional tags are checked if relevant arrays are provided.
+     * @param slots Optional array of slot names to check for.
+     * @param parts Optional array of part names to check for.
+     * @param events Optional array of event names to check for.
+     * @param props Optional array of CSS properties to check for.
+     * @param dependencies Optional array of dependencies to check for.
+     * @returns An array of IJSDocCheckerResult containing class names and missing JSDoc tags.
+     */
+    validate(slots?: Array<string>, parts?: Array<string>, events?: Array<string>, props?: Array<string>, dependencies?: Array<string>): Array<IJSDocCheckerResult>;
+    /**
+     * Fixes the JSDoc comment of a class declaration node to match the specified schema.
+     *
+     * @param name - The name to use in the JSDoc.
+     * @param element - The element name to use in the JSDoc.
+     * @param category - The category to use in the JSDoc.
+     * @param dependencies - An array of dependencies with their descriptions to be included in the JSDoc.
+     * @param description - The description to use in the JSDoc.
+     * @param slots - An array of slots with their descriptions to be included in the JSDoc.
+     * @param cssparts - An array of cssparts with their descriptions to be included in the JSDoc.
+     * @param cssprops - An array of cssprops with their descriptions to be included in the JSDoc.
+     * @param events - An array of events with their descriptions to be included in the JSDoc.
+     */
+    fix(name: string, element: string, category: string, dependencies?: Array<{
+        name: string;
+        type: string;
+        description: string;
+    }>, description?: string, slots?: Array<{
+        name: string;
+        description: string;
+    }>, cssparts?: Array<{
+        name: string;
+        description: string;
+    }>, cssprops?: Array<{
+        name: string;
+        type: string;
+        description: string;
+    }>, events?: Array<{
+        name: string;
+        description: string;
+    }>): void;
+    /**
+     * Validates if the tag comment matches a specific format using a regex pattern.
+     *
+     * @param comment - The tag comment to validate.
+     * @param pattern - The regex pattern to match against.
+     * @returns True if the comment matches the pattern, false otherwise.
+     */
+    private validateTagWithSpecificFormat;
+    /**
+     * Extracts JSDoc tags from the class declaration node.
+     * @param node The class declaration node.
+     * @returns An array of JSDoc tags found in the node.
+     */
+    private extractJSDocTags;
+    /**
+     * Generates a correct JSDoc comment with the right order of attributes, including dynamic parts.
+     *
+     * @param name - The name to use in the JSDoc.
+     * @param element - The element name to use in the JSDoc.
+     * @param category - The category to use in the JSDoc.
+     * @param dependencies - An array of dependencies with their descriptions to be included in the JSDoc.
+     * @param description - The description to use in the JSDoc. Defaults to "TBD" if not provided.
+     * @param slots - An array of slots with their descriptions to be included in the JSDoc.
+     * @param cssparts - An array of cssparts with their descriptions to be included in the JSDoc.
+     * @param cssprops - An array of cssprops with their descriptions to be included in the JSDoc.
+     * @param events - An array of events with their descriptions to be included in the JSDoc.
+     * @returns A string containing the formatted JSDoc comment.
+     */
+    private generateCorrectJSDoc;
+}
+//# sourceMappingURL=JSDocChecker.d.ts.map

package/executors/lit-docs/JSDocChecker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSDocChecker.d.ts","sourceRoot":"","sources":["../../../src/executors/lit-docs/JSDocChecker.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,KAAK,CAAC,aAAa,GAAG,MAAM,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC;IACrJ,cAAc,EAAE;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACrB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACxB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACtB,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACxB,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B,CAAC;IACF,YAAY,EAAE;QACV,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,YAAY,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,WAAW,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KAC9B,CAAC;CACL;AAED;;;GAGG;AACH,qBAAa,YAAY;IAErB,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC;;;OAGG;gBACgB,QAAQ,EAAE,MAAM;IAKnC;;;;;;;;;OASG;IACI,QAAQ,CACX,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACtB,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EACrB,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAC7B,KAAK,CAAC,mBAAmB,CAAC;IAoF7B;;;;;;;;;;;;OAYG;IACI,GAAG,CACN,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,YAAY,GAAE,KAAK,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACvB,CAAM,EACP,WAAW,GAAE,MAAc,EAC3B,KAAK,GAAE,KAAK,CAAC;QACT,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACvB,CAAM,EACP,QAAQ,GAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACvB,CAAM,EACP,QAAQ,GAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACvB,CAAM,EACP,MAAM,GAAE,KAAK,CAAC;QACV,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACvB,CAAM,GACR,IAAI;IA+CP;;;;;;OAMG;IACH,OAAO,CAAC,6BAA6B;IAOrC;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAsBxB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,oBAAoB;CAgE/B"}

package/executors/lit-docs/JSDocChecker.js

@@ -0,0 +1,240 @@
+"use strict";
+/* eslint-disable complexity */
+// #region Imports
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSDocChecker = void 0;
+const utilities_1 = require("@breadstone-infrastructure/utilities");
+const ts = __importStar(require("typescript"));
+/**
+ * JSDocChecker is responsible for verifying the completeness of JSDoc comments
+ * on TypeScript classes decorated with @Component.
+ */
+class JSDocChecker {
+    _correctOrder;
+    _filePath;
+    /**
+     * Initializes a new instance of the JSDocChecker class.
+     * @param filePath The path to the TypeScript file to be checked.
+     */
+    constructor(filePath) {
+        this._correctOrder = ['description', 'name', 'element', 'category', 'slot', 'csspart', 'cssprop', 'fires', 'dependency', 'example', 'public'];
+        this._filePath = filePath;
+    }
+    /**
+     * Validates the JSDoc comments in the TypeScript file against the specified schema.
+     * Ensures that all required tags are present and optional tags are checked if relevant arrays are provided.
+     * @param slots Optional array of slot names to check for.
+     * @param parts Optional array of part names to check for.
+     * @param events Optional array of event names to check for.
+     * @param props Optional array of CSS properties to check for.
+     * @param dependencies Optional array of dependencies to check for.
+     * @returns An array of IJSDocCheckerResult containing class names and missing JSDoc tags.
+     */
+    validate(slots, parts, events, props, dependencies) {
+        const fileContent = utilities_1.File.readAllText(this._filePath, 'utf8');
+        const sourceFile = ts.createSourceFile(this._filePath, fileContent, ts.ScriptTarget.Latest, true);
+        const results = [];
+        const visit = (node) => {
+            if (ts.isClassDeclaration(node)) {
+                const className = node.name?.getText() ?? 'UnnamedClass';
+                const jsDocTags = this.extractJSDocTags(node);
+                const tagKeys = jsDocTags.map((tag) => tag.key);
+                // Required tags to check
+                const requiredTags = ['description', 'name', 'element', 'category', 'example', 'public'];
+                const missingRequiredTags = requiredTags.filter((tag) => !tagKeys.includes(tag));
+                // Optional tags
+                const missingSlots = slots?.filter((slot) => !jsDocTags.some((tag) => tag.key === 'slot' && tag.value.includes(slot))) ?? [];
+                const missingParts = parts?.filter((part) => !jsDocTags.some((tag) => tag.key === 'csspart' && tag.value.includes(part))) ?? [];
+                const missingEvents = events?.filter((event) => !jsDocTags.some((tag) => tag.key === 'fires' && tag.value.includes(event))) ?? [];
+                const missingProps = props?.filter((prop) => !jsDocTags.some((tag) => tag.key === 'cssprop' && tag.value.includes(prop))) ?? [];
+                const missingDependencies = dependencies?.filter((dep) => !jsDocTags.some((tag) => tag.key === 'dependency' && tag.value.includes(dep))) ?? [];
+                const missingTags = [
+                    ...missingRequiredTags,
+                    ...missingSlots.length > 0 ? ['slot'] : [],
+                    ...missingParts.length > 0 ? ['csspart'] : [],
+                    ...missingEvents.length > 0 ? ['fires'] : [],
+                    ...missingProps.length > 0 ? ['cssprop'] : [],
+                    ...missingDependencies.length > 0 ? ['dependency'] : []
+                ];
+                const missingDetails = {
+                    slot: missingSlots.length > 0 ? missingSlots : undefined,
+                    csspart: missingParts.length > 0 ? missingParts : undefined,
+                    fires: missingEvents.length > 0 ? missingEvents : undefined,
+                    cssprop: missingProps.length > 0 ? missingProps : undefined,
+                    dependency: missingDependencies.length > 0 ? missingDependencies : undefined
+                };
+                // Check the order of tags
+                const currentOrder = tagKeys;
+                const expectedOrder = this._correctOrder.filter((tag) => currentOrder.includes(tag));
+                const orderDetails = {
+                    currentOrder: Array.from(new Set(currentOrder)),
+                    correctOrder: this._correctOrder,
+                    missingTags: new Array()
+                };
+                // Check if the order of tags is correct
+                if (expectedOrder.length > 1) {
+                    for (let i = 0; i < expectedOrder.length - 1; i++) {
+                        const currentTag = expectedOrder[i];
+                        const nextTag = expectedOrder[i + 1];
+                        if (currentOrder.indexOf(currentTag) > currentOrder.indexOf(nextTag)) {
+                            orderDetails.missingTags = expectedOrder;
+                            break;
+                        }
+                    }
+                }
+                if (missingTags.length > 0 || orderDetails.missingTags.length > 0) {
+                    results.push({
+                        className,
+                        missingTags,
+                        missingDetails,
+                        orderDetails
+                    });
+                }
+            }
+            ts.forEachChild(node, visit);
+        };
+        visit(sourceFile);
+        return results;
+    }
+    /**
+     * Fixes the JSDoc comment of a class declaration node to match the specified schema.
+     *
+     * @param name - The name to use in the JSDoc.
+     * @param element - The element name to use in the JSDoc.
+     * @param category - The category to use in the JSDoc.
+     * @param dependencies - An array of dependencies with their descriptions to be included in the JSDoc.
+     * @param description - The description to use in the JSDoc.
+     * @param slots - An array of slots with their descriptions to be included in the JSDoc.
+     * @param cssparts - An array of cssparts with their descriptions to be included in the JSDoc.
+     * @param cssprops - An array of cssprops with their descriptions to be included in the JSDoc.
+     * @param events - An array of events with their descriptions to be included in the JSDoc.
+     */
+    fix(name, element, category, dependencies = [], description = 'TBD', slots = [], cssparts = [], cssprops = [], events = []) {
+        const fileContent = utilities_1.File.readAllText(this._filePath, 'utf8');
+        const sourceFile = ts.createSourceFile(this._filePath, fileContent, ts.ScriptTarget.Latest, true);
+        const updatedContent = [];
+        const originalContentLines = fileContent.split('\n');
+        const visit = (node) => {
+            if (ts.isClassDeclaration(node)) {
+                const correctJSDoc = this.generateCorrectJSDoc(name, element, category, dependencies, description, slots, cssparts, cssprops, events);
+                const className = node.name?.getText() ?? 'UnnamedClass';
+                console.log(`Updating JSDoc for class: ${className}`);
+                // Insert JSDoc comment right before the class declaration
+                const start = node.getStart(sourceFile);
+                const preClassContent = originalContentLines.slice(0, start).join('\n');
+                const postClassContent = originalContentLines.slice(start).join('\n');
+                // Construct updated content
+                updatedContent.push(preClassContent, correctJSDoc, postClassContent);
+            }
+            ts.forEachChild(node, visit);
+        };
+        visit(sourceFile);
+        // This writes the updated content back to the file
+        utilities_1.File.writeAllText(this._filePath, updatedContent.join('\n'), 'utf8');
+    }
+    /**
+     * Validates if the tag comment matches a specific format using a regex pattern.
+     *
+     * @param comment - The tag comment to validate.
+     * @param pattern - The regex pattern to match against.
+     * @returns True if the comment matches the pattern, false otherwise.
+     */
+    validateTagWithSpecificFormat(comment, pattern) {
+        if (!comment) {
+            return false;
+        }
+        return pattern.test(comment);
+    }
+    /**
+     * Extracts JSDoc tags from the class declaration node.
+     * @param node The class declaration node.
+     * @returns An array of JSDoc tags found in the node.
+     */
+    extractJSDocTags(node) {
+        const jsDocTags = [];
+        const jsDocs = node.jsDoc;
+        jsDocs?.forEach((jsDoc) => {
+            jsDoc.tags?.forEach((tag) => {
+                jsDocTags.push({
+                    key: tag.tagName.text,
+                    value: tag.comment?.toString() ?? ''
+                });
+            });
+        });
+        return jsDocTags;
+    }
+    /**
+     * Generates a correct JSDoc comment with the right order of attributes, including dynamic parts.
+     *
+     * @param name - The name to use in the JSDoc.
+     * @param element - The element name to use in the JSDoc.
+     * @param category - The category to use in the JSDoc.
+     * @param dependencies - An array of dependencies with their descriptions to be included in the JSDoc.
+     * @param description - The description to use in the JSDoc. Defaults to "TBD" if not provided.
+     * @param slots - An array of slots with their descriptions to be included in the JSDoc.
+     * @param cssparts - An array of cssparts with their descriptions to be included in the JSDoc.
+     * @param cssprops - An array of cssprops with their descriptions to be included in the JSDoc.
+     * @param events - An array of events with their descriptions to be included in the JSDoc.
+     * @returns A string containing the formatted JSDoc comment.
+     */
+    generateCorrectJSDoc(name, element, category, dependencies = [], description = 'TBD', slots = [], cssparts = [], cssprops = [], events = []) {
+        // Generate the dynamic parts for slots, cssparts, cssprops, events, and dependencies
+        const slotsSection = slots.map((slot) => ` * @slot ${slot.name} - ${slot.description}`).join('\n');
+        const csspartsSection = cssparts.map((part) => ` * @csspart ${part.name} - ${part.description}`).join('\n');
+        const csspropsSection = cssprops.map((prop) => ` * @cssprop {${prop.type}} ${prop.name} - ${prop.description}`).join('\n');
+        const eventsSection = events.map((event) => ` * @fires ${event.name} - ${event.description}`).join('\n');
+        const dependenciesSection = dependencies.map((dep) => ` * @dependency {${dep.type}} ${dep.name} - ${dep.description}`).join('\n');
+        return `
+/**
+ * ${name} - An interactive UI element typically used to trigger actions or user interactions.
+ *
+ * @description
+ * ${description}
+ *
+ * @name ${name}
+ * @element ${element}
+ * @category ${category}
+ *
+${slotsSection}
+ *
+${csspartsSection}
+ *
+${csspropsSection}
+ *
+${eventsSection}
+ *
+${dependenciesSection}
+ *
+ * @example
+ * <${element} label="Button"></${element}>
+ *
+ * @public
+ */
+`.trim();
+    }
+}
+exports.JSDocChecker = JSDocChecker;
+//# sourceMappingURL=JSDocChecker.js.map

package/executors/lit-docs/JSDocChecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSDocChecker.js","sourceRoot":"","sources":["../../../src/executors/lit-docs/JSDocChecker.ts"],"names":[],"mappings":";AAAA,+BAA+B;AAC/B,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;AAElB,oEAA4D;AAC5D,+CAAiC;AAwBjC;;;GAGG;AACH,MAAa,YAAY;IAEJ,aAAa,CAAgB;IAC7B,SAAS,CAAS;IAEnC;;;OAGG;IACH,YAAmB,QAAgB;QAC/B,IAAI,CAAC,aAAa,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;QAC9I,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAED;;;;;;;;;OASG;IACI,QAAQ,CACX,KAAqB,EACrB,KAAqB,EACrB,MAAsB,EACtB,KAAqB,EACrB,YAA4B;QAE5B,MAAM,WAAW,GAAG,gBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAClC,IAAI,CAAC,SAAS,EACd,WAAW,EACX,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,IAAI,CACP,CAAC;QAEF,MAAM,OAAO,GAA+B,EAAE,CAAC;QAE/C,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;YAC5B,IAAI,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,cAAc,CAAC;gBACzD,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC9C,MAAM,OAAO,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAEhD,yBAAyB;gBACzB,MAAM,YAAY,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;gBACzF,MAAM,mBAAmB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBAEjF,gBAAgB;gBAChB,MAAM,YAAY,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAC7H,MAAM,YAAY,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChI,MAAM,aAAa,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAClI,MAAM,YAAY,GAAG,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAChI,MAAM,mBAAmB,GAAG,YAAY,EAAE,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,YAAY,IAAI,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;gBAE/I,MAAM,WAAW,GAAG;oBAChB,GAAG,mBAAmB;oBACtB,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC1C,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC7C,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC5C,GAAG,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE;oBAC7C,GAAG,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EAAE;iBACpB,CAAC;gBAExC,MAAM,cAAc,GAAG;oBACnB,IAAI,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;oBACxD,OAAO,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;oBAC3D,KAAK,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;oBAC3D,OAAO,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;oBAC3D,UAAU,EAAE,mBAAmB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,SAAS;iBAC/E,CAAC;gBAEF,0BAA0B;gBAC1B,MAAM,YAAY,GAAG,OAAO,CAAC;gBAC7B,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;gBAErF,MAAM,YAAY,GAAG;oBACjB,YAAY,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC;oBAC/C,YAAY,EAAE,IAAI,CAAC,aAAa;oBAChC,WAAW,EAAE,IAAI,KAAK,EAAU;iBACnC,CAAC;gBAEF,wCAAwC;gBACxC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;wBAChD,MAAM,UAAU,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;wBACpC,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;wBACrC,IAAI,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;4BACnE,YAAY,CAAC,WAAW,GAAG,aAAa,CAAC;4BACzC,MAAM;wBACV,CAAC;oBACL,CAAC;gBACL,CAAC;gBAED,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAChE,OAAO,CAAC,IAAI,CAAC;wBACT,SAAS;wBACT,WAAW;wBACX,cAAc;wBACd,YAAY;qBACf,CAAC,CAAC;gBACP,CAAC;YACL,CAAC;YAED,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC;QAEF,KAAK,CAAC,UAAU,CAAC,CAAC;QAClB,OAAO,OAAO,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,GAAG,CACN,IAAY,EACZ,OAAe,EACf,QAAgB,EAChB,eAIK,EAAE,EACP,cAAsB,KAAK,EAC3B,QAGK,EAAE,EACP,WAGK,EAAE,EACP,WAIK,EAAE,EACP,SAGK,EAAE;QAEP,MAAM,WAAW,GAAG,gBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,UAAU,GAAG,EAAE,CAAC,gBAAgB,CAClC,IAAI,CAAC,SAAS,EACd,WAAW,EACX,EAAE,CAAC,YAAY,CAAC,MAAM,EACtB,IAAI,CACP,CAAC;QAEF,MAAM,cAAc,GAAkB,EAAE,CAAC;QACzC,MAAM,oBAAoB,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAErD,MAAM,KAAK,GAAG,CAAC,IAAa,EAAE,EAAE;YAC5B,IAAI,EAAE,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,oBAAoB,CAC1C,IAAI,EACJ,OAAO,EACP,QAAQ,EACR,YAAY,EACZ,WAAW,EACX,KAAK,EACL,QAAQ,EACR,QAAQ,EACR,MAAM,CACT,CAAC;gBAEF,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,cAAc,CAAC;gBACzD,OAAO,CAAC,GAAG,CAAC,6BAA6B,SAAS,EAAE,CAAC,CAAC;gBAEtD,0DAA0D;gBAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;gBACxC,MAAM,eAAe,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxE,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAEtE,4BAA4B;gBAC5B,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,EAAE,gBAAgB,CAAC,CAAC;YACzE,CAAC;YAED,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC;QAEF,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,mDAAmD;QACnD,gBAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;OAMG;IACK,6BAA6B,CAAC,OAA2B,EAAE,OAAe;QAC9E,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,OAAO,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACK,gBAAgB,CAAC,IAAyB;QAI9C,MAAM,SAAS,GAGV,EAAE,CAAC;QAER,MAAM,MAAM,GAAI,IAAY,CAAC,KAAoC,CAAC;QAClE,MAAM,EAAE,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YACtB,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACxB,SAAS,CAAC,IAAI,CAAC;oBACX,GAAG,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI;oBACrB,KAAK,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE;iBACvC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACK,oBAAoB,CACxB,IAAY,EACZ,OAAe,EACf,QAAgB,EAChB,eAIK,EAAE,EACP,cAAsB,KAAK,EAC3B,QAGK,EAAE,EACP,WAGK,EAAE,EACP,WAIK,EAAE,EACP,SAGK,EAAE;QAEP,qFAAqF;QACrF,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnG,MAAM,eAAe,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5G,MAAM,eAAe,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,gBAAgB,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3H,MAAM,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzG,MAAM,mBAAmB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,mBAAmB,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAElI,OAAO;;KAEV,IAAI;;;KAGJ,WAAW;;WAEL,IAAI;cACD,OAAO;eACN,QAAQ;;EAErB,YAAY;;EAEZ,eAAe;;EAEf,eAAe;;EAEf,aAAa;;EAEb,mBAAmB;;;MAGf,OAAO,qBAAqB,OAAO;;;;CAIxC,CAAC,IAAI,EAAE,CAAC;IACL,CAAC;CAEJ;AAhUD,oCAgUC"}

package/executors/lit-docs/executor.d.ts

@@ -1,13 +1,13 @@
-import { LitDocsTaks } from '@breadstone-infrastructure/tasks';
 import type { ExecutorContext } from '@nx/devkit';
+import type { LitDocsTask } from './executor.task';
 /**
  * @public
  */
-export type LitDocsExecutorkOptions = Omit<LitDocsTaks.ILitDocsTaskOptions, 'cwd' | 'tsConfigJson' | 'packageJson' | 'verbose'>;
+export type LitDocsExecutorOptions = Omit<LitDocsTask.ILitDocsTaskOptions, 'cwd' | 'tsConfigJson' | 'packageJson' | 'verbose'>;
 /**
  * @public
  */
-export default function runExecutor(options: LitDocsExecutorkOptions, context: ExecutorContext): Promise<{
+export default function runExecutor(options: LitDocsExecutorOptions, context: ExecutorContext): Promise<{
     success: boolean;
 }>;
 //# sourceMappingURL=executor.d.ts.map

package/executors/lit-docs/executor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../../src/executors/lit-docs/executor.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAKlD;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,KAAK,GAAG,cAAc,GAAG,aAAa,GAAG,SAAS,CAAC,CAAC;AAEhI;;GAEG;AACH,wBAA8B,WAAW,CAAC,OAAO,EAAE,uBAAuB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAanI"}
+{"version":3,"file":"executor.d.ts","sourceRoot":"","sources":["../../../src/executors/lit-docs/executor.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAInD;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,EAAE,KAAK,GAAG,cAAc,GAAG,aAAa,GAAG,SAAS,CAAC,CAAC;AAE/H;;GAEG;AACH,wBAA8B,WAAW,CAAC,OAAO,EAAE,sBAAsB,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC,CAiBlI"}

package/executors/lit-docs/executor.js

@@ -1,19 +1,44 @@
 "use strict";
 // #region Imports
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = runExecutor;
-const tasks_1 = require("@breadstone-infrastructure/tasks");
 const getProjectRoot_1 = require("../../utils/getProjectRoot");
 /**
  * @public
  */
 async function runExecutor(options, context) {
     try {
-        await tasks_1.LitDocsTaks.run({
+        const task = (await Promise.resolve().then(() => __importStar(require('./executor.task')))).LitDocsTask;
+        await task.run({
             cwd: (0, getProjectRoot_1.getProjectRoot)(context),
             files: options.files,
             ignore: options.ignore,
-            verbose: context.isVerbose
+            verbose: context.isVerbose,
+            validateOrder: options.validateOrder,
+            validateTags: options.validateTags
         });
         return { success: true };
     }

package/executors/lit-docs/executor.js.map

@@ -1 +1 @@
-{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../src/executors/lit-docs/executor.ts"],"names":[],"mappings":";AAAA,kBAAkB;;AAgBlB,8BAaC;AA3BD,4DAA+D;AAE/D,+DAA4D;AAS5D;;GAEG;AACY,KAAK,UAAU,WAAW,CAAC,OAAgC,EAAE,OAAwB;IAChG,IAAI,CAAC;QACD,MAAM,mBAAW,CAAC,GAAG,CAAC;YAClB,GAAG,EAAE,IAAA,+BAAc,EAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9B,CAAC;AACL,CAAC"}
+{"version":3,"file":"executor.js","sourceRoot":"","sources":["../../../src/executors/lit-docs/executor.ts"],"names":[],"mappings":";AAAA,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;AAgBlB,8BAiBC;AA9BD,+DAA4D;AAU5D;;GAEG;AACY,KAAK,UAAU,WAAW,CAAC,OAA+B,EAAE,OAAwB;IAC/F,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,CAAC,wDAAa,iBAAiB,GAAC,CAAC,CAAC,WAAW,CAAC;QAE3D,MAAM,IAAI,CAAC,GAAG,CAAC;YACX,GAAG,EAAE,IAAA,+BAAc,EAAC,OAAO,CAAC;YAC5B,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,OAAO,EAAE,OAAO,CAAC,SAAS;YAC1B,aAAa,EAAE,OAAO,CAAC,aAAa;YACpC,YAAY,EAAE,OAAO,CAAC,YAAY;SACrC,CAAC,CAAC;QACH,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IAC9B,CAAC;AACL,CAAC"}

package/executors/lit-docs/executor.task.d.ts

@@ -0,0 +1,12 @@
+export declare namespace LitDocsTask {
+    interface ILitDocsTaskOptions {
+        cwd: string;
+        files: string | Array<string>;
+        ignore?: Array<string>;
+        verbose?: boolean;
+        validateOrder?: boolean;
+        validateTags?: boolean;
+    }
+    function run(options: ILitDocsTaskOptions): Promise<void>;
+}
+//# sourceMappingURL=executor.task.d.ts.map

package/executors/lit-docs/executor.task.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"executor.task.d.ts","sourceRoot":"","sources":["../../../src/executors/lit-docs/executor.task.ts"],"names":[],"mappings":"AAQA,yBAAiB,WAAW,CAAC;IAEzB,UAAiB,mBAAmB;QAChC,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9B,MAAM,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACvB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,YAAY,CAAC,EAAE,OAAO,CAAC;KAC1B;IAED,SAAsB,GAAG,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAkJrE;CACJ"}