@breadstone-tools/cem-plugin 0.0.12-beta.0

package/Index.d.ts

@@ -0,0 +1,2 @@
+export type { PluginContext as Context, IAnalyzePhaseParams, ICollectPhaseParams, IInitializeParams, IModuleLinkPhaseParams, IPackageLinkPhaseParams, IPlugin } from './Plugin.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,aAAa,IAAI,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC"}

package/Index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Index.js.map

package/Index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Index.js","sourceRoot":"","sources":["../src/Index.ts"],"names":[],"mappings":""}

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/Plugin.d.ts

@@ -0,0 +1,169 @@
+import type { ILogger } from '@breadstone-infrastructure/utilities';
+import type { Module, Package } from '@breadstone-tools/cem-infrastructure';
+import type ts from 'typescript';
+/**
+ * Plugin Execution Context
+ *
+ * This context serves as a shared data environment for all plugins. It facilitates
+ * the exchange of arbitrary data among plugins and contains essential information
+ * about the current execution environment along with a collection of dynamic properties.
+ *
+ * The context includes:
+ *
+ * 1. **Execution Environment Information**:
+ *    - Details about the current runtime environment, including system configurations and settings.
+ *    - Relevant environmental variables that influence plugin behavior.
+ *
+ * 2. **Dynamic Properties**:
+ *    - A versatile collection of properties accessible and modifiable by all plugins.
+ *    - Can store various data types, such as user inputs, intermediate processing results, and configuration settings.
+ *
+ * 3. **Data Sharing Capabilities**:
+ *    - Enables seamless data sharing between plugins to ensure coordinated operations.
+ *    - Maintains consistency and integrity of shared data across different plugin processes.
+ *
+ * This context is crucial for preserving the state of plugin operations and supporting efficient plugin interactions within the system.
+ *
+ * @public
+ */
+export type PluginContext = {
+    program: ts.Program;
+    typeChecker: ts.TypeChecker;
+    debug: boolean;
+    verbose: boolean;
+    quiet: boolean;
+    logger: ILogger;
+} & Record<string, unknown>;
+/**
+ * Parameters for the initialize phase of the plugin.
+ *
+ * @public
+ */
+export interface IInitializeParams {
+    /**
+     * TypeScript API
+     */
+    ts: typeof ts;
+    /**
+     * The newly initialized manifest.
+     */
+    customElementsManifest: Package;
+    /**
+     * Plugin execution context. Pass arbitrary data here.
+     */
+    context: PluginContext;
+}
+/**
+ * Parameters for the package link phase of the plugin.
+ *
+ * @public
+ */
+export interface IPackageLinkPhaseParams {
+    /**
+     * TypeScript API
+     */
+    ts: typeof ts;
+    /**
+     * The newly initialized manifest.
+     */
+    customElementsManifest: Package;
+    /**
+     * Plugin execution context. Pass arbitrary data here.
+     */
+    context: PluginContext;
+}
+/**
+ * Parameters for the collect phase of the plugin.
+ *
+ * @public
+ */
+export interface ICollectPhaseParams {
+    /**
+     * TypeScript API
+     */
+    ts: typeof ts;
+    /**
+     * The current TypeScript AST Node
+     */
+    node: ts.Node;
+    /**
+     * Plugin execution context. Pass arbitrary data here.
+     */
+    context: PluginContext;
+}
+/**
+ * Parameters for the analyze phase of the plugin.
+ *
+ * @public
+ */
+export interface IAnalyzePhaseParams {
+    /**
+     * TypeScript API
+     */
+    ts: typeof ts;
+    /**
+     * The current TypeScript AST Node
+     */
+    node: ts.Node;
+    /**
+     * The current state of the current module's manifest
+     */
+    moduleDoc: Partial<Module>;
+    /**
+     * Plugin execution context. Pass arbitrary data here.
+     */
+    context: PluginContext;
+}
+/**
+ * Parameters for the module link phase of the plugin.
+ *
+ * @public
+ */
+export interface IModuleLinkPhaseParams {
+    /**
+     * The completed moduleDoc, i.e. the output of the analyze phase
+     */
+    moduleDoc: Module;
+    /**
+     * Plugin execution context. Pass arbitrary data here.
+     */
+    context: PluginContext;
+}
+/**
+ * A Custom Elements Manifest Analyzer plugin.
+ *
+ * @public
+ */
+export interface IPlugin {
+    /**
+     * The name of the plugin.
+     */
+    readonly name: string;
+    /**
+     * The plugin `init` hook that runs once for each plugin.
+     */
+    onInit?(params: IInitializeParams): void;
+    /**
+     * The plugin `collect` hook that runs in the collect phase.
+     * Runs for all modules in a project, before continuing to the `analyze` hook.
+     */
+    onCollect?(params: ICollectPhaseParams): void;
+    /**
+     * The plugin `analyze` hook that runs in the analyze phase.
+     * Runs for each AST node in each module.
+     * You can use this phase to access a module's AST nodes and mutate the manifest.
+     */
+    onAnalyze?(params: IAnalyzePhaseParams): void;
+    /**
+     * The plugin `moduleLink` hook that runs in the module link phase.
+     * Post-processing hook that runs for each module, after analyzing.
+     * All information about your module should now be available.
+     */
+    onModuleLink?(params: IModuleLinkPhaseParams): void;
+    /**
+     * The plugin `packageLink` hook that runs in the package link phase.
+     * Runs once per package, after modules have been parsed and after per-module post-processing.
+     */
+    onPackageLink?(params: IPackageLinkPhaseParams): void;
+}
+//# sourceMappingURL=Plugin.d.ts.map

package/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../src/Plugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,KAAK,EAAE,MAAM,YAAY,CAAC;AAIjC;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC;IACpB,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC;IAC5B,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACnB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE5B;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAE9B;;OAEG;IACH,EAAE,EAAE,OAAO,EAAE,CAAC;IAEd;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CAE1B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IAEpC;;OAEG;IACH,EAAE,EAAE,OAAO,EAAE,CAAC;IAEd;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CAE1B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAEhC;;OAEG;IACH,EAAE,EAAE,OAAO,EAAE,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CAE1B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAEhC;;OAEG;IACH,EAAE,EAAE,OAAO,EAAE,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CAE1B;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IAEnC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,EAAE,aAAa,CAAC;CAE1B;AAED;;;;GAIG;AACH,MAAM,WAAW,OAAO;IAEpB;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAEzC;;;OAGG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,SAAS,CAAC,CAAC,MAAM,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAE9C;;;;OAIG;IACH,YAAY,CAAC,CAAC,MAAM,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAEpD;;;OAGG;IACH,aAAa,CAAC,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAEzD"}

package/Plugin.js

@@ -0,0 +1,4 @@
+"use strict";
+// #region Imports
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Plugin.js.map

package/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../src/Plugin.ts"],"names":[],"mappings":";AAAA,kBAAkB"}

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@breadstone-tools/cem-plugin",
+    "description": "Custom Elements Manifest Plugin Library",
+    "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",
+        "comment-parser": "^1.4.1",
+        "typescript": "^5.8.3"
+    }
+}