@abi-software/simulationvuer 3.0.12 → 3.0.14

package/vuese-generator.js

@@ -5,133 +5,130 @@
  * To watch components changes for Vitepress on Dev Mode
  */
 
-import fs from 'fs'
-import path from 'path'
-import chokidar from 'chokidar'
-import { parseSource } from 'vue-docgen-api'
-import { Render } from '@vuese/markdown-render'
+import { Render } from "@vuese/markdown-render";
 
-const watchMode = process.argv.find((argv) => argv === 'watch')
+import chokidar from "chokidar";
+import fs from "node:fs";
+import path from "node:path";
+import { parseSource } from "vue-docgen-api";
 
-const componentsDir = 'src/components'
-const components = ['SimulationVuer.vue']
-const outputDir = 'docs/components'
+const watchMode = process.argv.find((argv) => argv === "watch");
 
-function generateMarkdown(file) {
-  const fileWithPath = `${componentsDir}/${file}`
-  const fileContent = fs.readFileSync(fileWithPath, 'utf-8')
+const componentsDir = "src/components";
+const components = ["SimulationVuer.vue"];
+const outputDir = "docs/components";
+
+async function generateMarkdown(file) {
+  const fileWithPath = `${componentsDir}/${file}`;
+  const fileContent = fs.readFileSync(fileWithPath, "utf-8");
 
   try {
-    // const parserResult = parser(fileContent)
-    const parserResult = parseSource(fileContent, fileWithPath)
-    parserResult.then((result) => {
-      const {
-        displayName: name,
-        description: desc,
-        props,
-        events,
-        methods
-      } = result
-
-      // transform props to vuese styles
-      const parseResult = {
-        name: name,
-        componentDesc: {
-          default: [desc]
-        },
-        props: transformData(props),
-        events: transformData(events),
-        methods: transformData(methods),
-      }
-      parseResult.name = 'SimulationVuer' // Because there has another name prop in component
-      const r = new Render(parseResult)
-      const renderResult = r.render()
-      const markdownResult = r.renderMarkdown()
-      const markdownContent = markdownResult.content
-      const componentName = path.basename(fileWithPath, '.vue')
-
-      if (!fs.existsSync(outputDir)) {
-        fs.mkdirSync(outputDir)
-      }
+    const result = await parseSource(fileContent, fileWithPath);
+    const {
+      displayName: name,
+      description: desc,
+      props,
+      events,
+      methods,
+    } = result;
+
+    // transform props to vuese styles
+    const parseResult = {
+      name: name,
+      componentDesc: {
+        default: [desc],
+      },
+      props: transformData(props),
+      events: transformData(events),
+      methods: transformData(methods),
+    };
+    parseResult.name = "SimulationVuer"; // Because there has another name prop in component
+    const r = new Render(parseResult);
+    const markdownResult = r.renderMarkdown();
+    const markdownContent = markdownResult.content;
+    const componentName = path.basename(fileWithPath, ".vue");
+
+    if (!fs.existsSync(outputDir)) {
+      fs.mkdirSync(outputDir);
+    }
+
+    await fs.promises.writeFile(
+      `${outputDir}/${componentName}.md`,
+      markdownContent,
+    );
 
-      fs.writeFile(`${outputDir}/${componentName}.md`, markdownContent, (err) => {
-        if (err) {
-          console.error(`Error writing markdown file for ${componentName}`, err)
-        } else {
-          console.log(`Markdown file for ${componentName} is generated!`)
-        }
-      })
-    })
-  } catch(e) {
-    console.error(e)
+    console.log(`Markdown file for ${componentName} is generated!`);
+  } catch (e) {
+    // log parse or write errors so the developer knows something went wrong
+    console.error(`Failed to generate markdown for ${file}:`, e);
   }
 }
 
 function transformData(data = []) {
   function capitalise(str) {
-    return str.charAt(0).toUpperCase() + str.slice(1)
+    return str.charAt(0).toUpperCase() + str.slice(1);
   }
 
   data.forEach((prop) => {
-    prop.name = prop.name
-
     if (prop.description) {
-      prop.describe = [prop.description.replaceAll('\n', ' ')]
+      prop.describe = [prop.description.replaceAll("\n", " ")];
     }
 
     if (prop.type) {
       // Handle multiple types separated by '|'
       // Convert to array to avoid markdown table issues
-      if (prop.type.name.indexOf('|') !== -1) {
-        prop.type = prop.type.name.split('|').map((item) => capitalise(item.trim()))
+      if (prop.type.name.indexOf("|") !== -1) {
+        prop.type = prop.type.name
+          .split("|")
+          .map((item) => capitalise(item.trim()));
       } else {
-        prop.type = capitalise(prop.type.name)
+        prop.type = capitalise(prop.type.name);
       }
     }
 
     if (prop.defaultValue) {
-      prop.default = prop.defaultValue.value.replaceAll('\n', ' ')
+      prop.default = prop.defaultValue.value.replaceAll("\n", " ");
     }
 
     // events
     if (prop.properties) {
-      prop.argumentsDesc = []
+      prop.argumentsDesc = [];
       prop.properties.forEach((param) => {
-        const argName = param.name || param.description
-        prop.argumentsDesc.push(argName)
-      })
+        const argName = param.name || param.description;
+        prop.argumentsDesc.push(argName);
+      });
     }
 
     // methods
     if (prop.params) {
-      prop.argumentsDesc = []
+      prop.argumentsDesc = [];
       prop.params.forEach((param) => {
-        const argName = param.description || param.name
-        prop.argumentsDesc.push(argName)
-      })
+        const argName = param.description || param.name;
+        prop.argumentsDesc.push(argName);
+      });
     }
-  })
+  });
   if (!data.length) {
-    return null
+    return null;
   }
-  return data
+  return data;
 }
 
 // To generate markdown files - one time
 components.forEach((component) => {
-  console.log(`Write markdown file for ${component} on first load.`)
-  generateMarkdown(component)
-})
+  console.log(`Write markdown file for ${component} on first load.`);
+  generateMarkdown(component);
+});
 
 // To watch component changes and generate markdown files
 if (watchMode) {
   const watcher = chokidar.watch(components, {
     cwd: componentsDir,
     ignoreInitial: true,
-  })
+  });
 
-  watcher.on('change', (file) => {
-    console.log(`The component ${file} has changed!`)
-    generateMarkdown(file)
-  })
+  watcher.on("change", (file) => {
+    console.log(`The component ${file} has changed!`);
+    generateMarkdown(file);
+  });
 }