Merge pull request #125 from break-stuff/add-global-configurations

Add global configurations
break-stuff · May 19, 2024 · a3f078b · a3f078b
2 parents 710b3de + d02d55b
commit a3f078b
Show file tree

Hide file tree

Showing 65 changed files with 1,242 additions and 579 deletions.
diff --git a/demo/lit-app/custom-elements.json b/demo/lit-app/custom-elements.json
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/cem-inheritance/CHANGELOG.md b/packages/cem-inheritance/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+- Added the ability to hide logs
+- Added the ability to skip the plugin
+
 ## 1.0.0
 
 - Initial release
diff --git a/packages/cem-inheritance/README.md b/packages/cem-inheritance/README.md
@@ -69,6 +69,10 @@ interface Options {
   ignore?: string[];
   /** External CEMs that your components extend */
   externalManifests?: any[];
+  /** Hides logs produced by the plugin */
+  hideLogs?: boolean;
+  /** Prevents plugin from executing */
+  skip?: boolean;
 }
 ```
 

diff --git a/packages/cem-inheritance/package.json b/packages/cem-inheritance/package.json
@@ -1,6 +1,6 @@
 {
   "name": "custom-elements-manifest-inheritance",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A tool for mapping inherited content (including class members, attributes, CSS parts, CSS variables, slots, and events) from parent classes in the Custom Elements Manifest",
   "main": "index.js",
   "module": "index.js",

diff --git a/packages/cem-inheritance/src/cem-inheritance-plugin.ts b/packages/cem-inheritance/src/cem-inheritance-plugin.ts
@@ -1,16 +1,11 @@
 import { updateCemInheritance } from "./cem-inheritance.js";
 import type { Options, Params } from "./types.js";
-import { logGreen } from "../../../tools/integrations/index.js";
 
 export function cemInheritancePlugin(options: Options = {}) {
   return {
     name: "cem-inheritance",
     packageLinkPhase({ customElementsManifest }: Params) {
-      console.log(
-        "[cem-inheritance-generator] - Updating Custom Elements Manifest..."
-      );
       updateCemInheritance(customElementsManifest, options);
-      logGreen("[cem-inheritance-generator] - Custom Elements Manifest update complete.");
     },
   };
 }
diff --git a/packages/cem-inheritance/src/cem-inheritance.ts b/packages/cem-inheritance/src/cem-inheritance.ts
@@ -1,5 +1,5 @@
 import { CEM, Component } from "../../../tools/cem-utils/index.js";
-import { createOutDir, logBlue, saveFile } from "../../../tools/integrations";
+import { createOutDir, logBlue, logYellow, saveFile } from "../../../tools/integrations";
 import { Options } from "./types.js";
 
 const completedClasses: string[] = [];
@@ -10,15 +10,19 @@ let externalComponents: Component[] = [];
 let updatedCEM: any = {};
 
 export function updateCemInheritance(cem: CEM, options: Options = {}) {
-  logBlue("[cem-inheritance-generator] - Updating Custom Elements Manifest...");
+  if(options.skip) {
+    logYellow("[cem-inheritance-generator] - Skipped", options.hideLogs)
+  }
+
+  logBlue("[cem-inheritance-generator] - Updating Custom Elements Manifest...", options.hideLogs);
   const newCem = generateUpdatedCem(cem, options);
   createOutDir(userConfig.outdir!);
   saveFile(
     userConfig.outdir!,
     userConfig.fileName!,
     JSON.stringify(newCem, null, 2)
   );
-  logBlue("[cem-inheritance-generator] - Custom Elements Manifest updated.");
+  logBlue("[cem-inheritance-generator] - Custom Elements Manifest updated.", options.hideLogs);
 }
 
 function updateOptions(options: Options = {}) {

diff --git a/packages/cem-inheritance/src/types.d.ts b/packages/cem-inheritance/src/types.d.ts
@@ -13,6 +13,10 @@ export interface Options {
   ignore?: string[];
   /** External CEMs that your components extend */
   externalManifests?: any[];
+  /** Hides logs produced by the plugin */
+  hideLogs?: boolean;
+  /** Prevents plugin from executing */
+  skip?: boolean;
 }
 
 export interface Params {

diff --git a/packages/custom-jsdoc-tags/CHANGELOG.md b/packages/custom-jsdoc-tags/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+- Added the ability to hide logs
+- Added the ability to skip the plugin
+
 ## 1.0.2
 
 - Prevent crash when no tags exist

diff --git a/packages/custom-jsdoc-tags/README.md b/packages/custom-jsdoc-tags/README.md
@@ -185,6 +185,10 @@ interface Options {
       isArray?: boolean;
     };
   };
+  /** Hides logs produced by the plugin */
+  hideLogs: boolean;
+  /** Prevents plugin from executing */
+  skip: boolean;
 }
 ```
 

diff --git a/packages/custom-jsdoc-tags/package.json b/packages/custom-jsdoc-tags/package.json
@@ -1,6 +1,6 @@
 {
   "name": "cem-plugin-custom-jsdoc-tags",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Translates custom JSDoc tags to the Custom Elements Manifest",
   "main": "index.js",
   "module": "index.js",

diff --git a/packages/custom-jsdoc-tags/src/cem-plugin.ts b/packages/custom-jsdoc-tags/src/cem-plugin.ts
@@ -1,8 +1,13 @@
-import { parse } from 'comment-parser';
-import type { CEM, Component } from "../../../tools/cem-utils";
+import { parse } from "comment-parser";
+import type { Component } from "../../../tools/cem-utils";
+import { logBlue, logYellow } from "../../../tools/integrations";
 
 export interface Options {
   tags?: CustomTag;
+  /** Hides logs produced by the plugin */
+  hideLogs?: boolean;
+  /** Prevents plugin from executing */
+  skip?: boolean;
 }
 
 export interface CustomTag {
@@ -22,7 +27,7 @@ interface CEMTag {
 }
 
 let userOptions: Options = {
-  tags: {}
+  tags: {},
 };
 
 /**
@@ -35,19 +40,27 @@ export function customJSDocTagsPlugin(
     tags: {},
   }
 ) {
+  if(options.skip) {
+    logYellow("[custom-jsdoc-tags] - Skipped", options.hideLogs);
+    return;
+  }
+
+  logBlue("[custom-jsdoc-tags] - Updating Custom Elements Manifest...", options.hideLogs);
   userOptions = options;
 
   return {
     name: "custom-jsdoc-tags-plugin",
     analyzePhase({ ts, node, moduleDoc }: any) {
-      if(node.kind !== ts.SyntaxKind.ClassDeclaration) {
+      if (node.kind !== ts.SyntaxKind.ClassDeclaration) {
         return;
       }
 
       const className = node.name.getText();
-      const component = moduleDoc?.declarations?.find((declaration: Component) => declaration.name === className);
+      const component = moduleDoc?.declarations?.find(
+        (declaration: Component) => declaration.name === className
+      );
       const customTags = Object.keys(userOptions.tags || {});
-      let customComments = '/**';
+      let customComments = "/**";
 
       node.jsDoc?.forEach((jsDoc: any) => {
         jsDoc?.tags?.forEach((tag: any) => {
@@ -60,22 +73,22 @@ export function customJSDocTagsPlugin(
       });
 
       const parsed = parse(`${customComments}\n */`);
-      parsed[0]?.tags?.forEach(tagMeta => {
-        const tagOptions  = userOptions.tags![tagMeta.tag]
-        if(!tagOptions) {
+      parsed[0]?.tags?.forEach((tagMeta) => {
+        const tagOptions = userOptions.tags![tagMeta.tag];
+        if (!tagOptions) {
           return;
         }
 
         const propName = tagOptions.mappedName || tagMeta.tag;
         const existingProp = component[propName];
         const cemTag: CEMTag = {
-          name: tagMeta.name === '-' ? '' : tagMeta.name,
+          name: tagMeta.name === "-" ? "" : tagMeta.name,
           default: tagMeta.default,
-          description: tagMeta.description.replace(/^\s?-/, '').trim(), // removes leading dash
-          type: tagMeta.type ? { text: tagMeta.type } : undefined
+          description: tagMeta.description.replace(/^\s?-/, "").trim(), // removes leading dash
+          type: tagMeta.type ? { text: tagMeta.type } : undefined,
         };
 
-        if(!existingProp && tagOptions.isArray) {
+        if (!existingProp && tagOptions.isArray) {
           component[propName] = [cemTag];
         } else if (Array.isArray(component[propName])) {
           component[propName].push(cemTag);
@@ -85,6 +98,8 @@ export function customJSDocTagsPlugin(
           component[propName] = cemTag;
         }
       });
-    }
-  }
+
+      logBlue("[custom-jsdoc-tags] - Custom Elements Manifest updated.", options.hideLogs);
+    },
+  };
 }
diff --git a/packages/deprecator/CHANGELOG.md b/packages/deprecator/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+- Added the ability to hide logs
+- Added the ability to skip the plugin
+
 ## 1.0.0
 
 - Initial release
diff --git a/packages/deprecator/README.md b/packages/deprecator/README.md
@@ -133,6 +133,10 @@ interface Options {
   outdir?: string;
   /** Class names of any components you would like to exclude from inheritance */
   exclude?: string[];
+  /** Hides logs produced by the plugin */
+  hideLogs?: boolean;
+  /** Prevents plugin from executing */
+  skip?: boolean;
 }
 ```
 

diff --git a/packages/deprecator/package.json b/packages/deprecator/package.json
@@ -1,6 +1,6 @@
 {
   "name": "custom-elements-manifest-deprecator",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A tool for marking Custom Elements Manifest data as 'deprecated'",
   "main": "index.js",
   "module": "index.js",

diff --git a/packages/deprecator/src/deprecator-plugin.ts b/packages/deprecator/src/deprecator-plugin.ts
@@ -1,16 +1,11 @@
 import { updateCemDeprecations } from "./deprecator.js";
 import type { Options, Params } from "./types.js";
-import { logGreen } from "../../../tools/integrations/index.js";
 
 export function cemDeprecatorPlugin(options: Options = {}) {
   return {
     name: "cem-deprecator",
     packageLinkPhase({ customElementsManifest }: Params) {
-      console.log(
-        "[cem-deprecator] - Updating Custom Elements Manifest..."
-      );
       updateCemDeprecations(customElementsManifest, options);
-      logGreen("[cem-deprecator] - Custom Elements Manifest update complete.");
     },
   };
 }
diff --git a/packages/deprecator/src/deprecator.ts b/packages/deprecator/src/deprecator.ts
@@ -9,15 +9,15 @@ import { Options } from "./types.js";
 let userConfig: Options = {};
 
 export function updateCemDeprecations(cem: CEM, options: Options = {}) {
-  logBlue("[cem-inheritance-generator] - Updating Custom Elements Manifest...");
+  logBlue("[cem-deprecator] - Updating Custom Elements Manifest...", options.hideLogs);
   const newCem = generateUpdatedCem(cem, options);
   createOutDir(userConfig.outdir!);
   saveFile(
     userConfig.outdir!,
     userConfig.fileName!,
     JSON.stringify(newCem, null, 2)
   );
-  logBlue("[cem-inheritance-generator] - Custom Elements Manifest updated.");
+  logBlue("[cem-deprecator] - Custom Elements Manifest updated.", options.hideLogs);
 }
 
 function updateOptions(options: Options = {}) {

diff --git a/packages/deprecator/src/types.d.ts b/packages/deprecator/src/types.d.ts
@@ -11,13 +11,16 @@ export interface Options {
   outdir?: string;
   /** Class names of any components you would like to exclude from inheritance */
   exclude?: string[];
+  /** Hides logs produced by the plugin */
+  hideLogs?: boolean;
+  /** Prevents plugin from executing */
+  skip?: boolean;
 }
 
 export interface Params {
   customElementsManifest: CEM;
 }
 
-
 export interface Omit {
   [key: string]: {
     cssProperties?: string[];