Script/ce-update

packages/muon/components/cta/src/cta-component.js

@@ -13,6 +13,7 @@ import styles from './cta-styles.css';
  * A call-to-action allows users to take action once they are ready for it.
  *
  * @element cta
+ * @placement {"div"|"muon-form"}
  */
 
 export class Cta extends ScopedElementsMixin(MuonElement) {

packages/muon/components/icon/src/icon-component.js

@@ -14,6 +14,7 @@ import styles from './icon-styles.css';
  * Icons are visual symbols that are used to represent objects or actions to reduce cognitive load to a user.
  *
  * @element icon
+ * @placement {"muon-form"}
  */
 
 export class Icon extends MuonElement {

packages/muon/components/inputter/src/inputter-component.js

@@ -23,6 +23,10 @@ import slottedStyles from './inputter-styles.slotted.css';
  * date, tel, number, textarea, search.
  *
  * @element inputter
+ * @slot {"label"} label - The label for the input.
+ * @slot {"input"|"select"} - The form element passed in such as input, select, textarea.
+ * @slot {"div"} tip-details - The tip details related to the helper.
+ * @placement {"muon-form"}
  */
 
 export class Inputter extends ScopedElementsMixin(ValidationMixin(MaskMixin(MuonElement))) {

packages/muon/scripts/utils/index.mjs

@@ -181,6 +181,32 @@ const getAliasPaths = (type) => {
   return undefined;
 };
 
+const updateAnalyzedResults = (results, jsonOutput) => {
+  results.forEach((result) => {
+    const tagName = result.componentDefinitions[0]?.tagName;
+    const declaration = result.componentDefinitions[0]?.declaration;
+
+    const slots = declaration.slots.map((slot) => {
+      return { 
+        name: slot.name,
+        description: slot.jsDoc.description, 
+        permittedTagNames: slot.permittedTagNames
+      }
+    });
+    const placements = declaration?.jsDoc.tags?.filter((jsDocTag) => jsDocTag.tag === 'placement')?.[0]?.comment;
+
+    if (slots || placements) {
+      const jsonTag = jsonOutput.tags.find((tag) => tag.name === tagName);
+      if (slots?.length > 0) {
+        jsonTag["slots"] = slots;
+      }
+      if (placements) {
+        jsonTag["placements"] = placements.replaceAll('"', '').replace('{', '').replace('}', '').split('|');
+      }
+    }
+  });
+};
+
 const sourceFilesAnalyzer = async () => {
   const files = await findComponents();
   const paths = getAliasPaths('glob');
@@ -233,7 +259,10 @@ const sourceFilesAnalyzer = async () => {
     console.error('---------------------------------------------');
     process.exit(1);
   }
-  return transformAnalyzerResult('json', results, program);
+  const jsonResults =  transformAnalyzerResult('json', results, program);
+  const outputJSON = JSON.parse(jsonResults);
+  updateAnalyzedResults(results, outputJSON);
+  return JSON.stringify(outputJSON, null, 2);
 };
 
 const styleDictionary = async () => {