@abi-software/scaffoldvuer 1.21.1-beta.2 → 2.0.0

package/src/store/index.js

@@ -1,24 +1,24 @@
-import { defineStore } from 'pinia'
+import { defineStore } from 'pinia';
 
 /**
  * Activate the store when run the application individually.
- * If the store exist in parent application, 
+ * If the store exist in parent application,
  * instead of creating a new store it will access the parent main store.
  */
 export const useMainStore = defineStore('main', {
   state: () => ({
     userProfile: {
-      token: ''
+      token: '',
     },
   }),
   getters: {
     userToken(state) {
-      return state.userProfile.token
+      return state.userProfile.token;
     },
   },
   actions: {
     setUserToken(value) {
-      this.userProfile.token = value
+      this.userProfile.token = value;
     },
-  }
-})
+  },
+});

package/vite.config.js

@@ -1,79 +1,80 @@
-import path from "path";
-import { defineConfig } from 'vite'
-import vue from '@vitejs/plugin-vue'
-import Components from 'unplugin-vue-components/vite'
-import { ElementPlusResolver } from 'unplugin-vue-components/resolvers'
-import { nodePolyfills } from 'vite-plugin-node-polyfills'
+import path from 'path';
+import { defineConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import AutoImport from 'unplugin-auto-import/vite';
+import Components from 'unplugin-vue-components/vite';
+import { ElementPlusResolver } from 'unplugin-vue-components/resolvers';
+import { nodePolyfills } from 'vite-plugin-node-polyfills';
 
 // https://vitejs.dev/config/
-export default defineConfig(({ command, mode }) => {
+export default defineConfig(({ command }) => {
   const config = {
     css: {
-        preprocessorOptions: {
-          scss: {
-            api: 'modern-compiler',
-            additionalData: `@use '@/assets/styles' as *;`
-          },
+      preprocessorOptions: {
+        scss: {
+          api: 'modern-compiler',
+          additionalData: `@use '@/assets/styles' as *;`,
         },
+      },
     },
     plugins: [
-        vue(),
-        Components({
-          // allow auto load markdown components under `./src/components/`
-          extensions: ['vue', 'md'],
-          // allow auto import and register components used in markdown
-          include: [/\.vue$/, /\.vue\?vue/, /\.md$/],
-          resolvers: [
-            ElementPlusResolver({
-              importStyle: 'sass',
-            }),
-          ],
-          dts: 'src/components.d.ts',
-        }),
-
-        // https://github.com/antfu/unocss
-        // see unocss.config.ts for config
+      vue(),
+      AutoImport({
+        resolvers: [ElementPlusResolver()],
+      }),
+      Components({
+        // allow auto load markdown components under `./src/components/`
+        extensions: ['vue', 'md'],
+        // allow auto import and register components used in markdown
+        include: [/\.vue$/, /\.vue\?vue/, /\.md$/],
+        resolvers: [
+          ElementPlusResolver({
+            importStyle: 'sass',
+          }),
+        ],
+        dts: 'src/components.d.ts',
+      }),
     ],
     resolve: {
       alias: {
         '@': path.resolve(import.meta.dirname, './src'),
-      }
+      },
     },
     build: {
       lib: {
-        entry: path.resolve(import.meta.dirname, "./src/components/index.js"),
-        name: "ScaffoldVuer",
+        entry: path.resolve(import.meta.dirname, './src/components/index.js'),
+        name: 'ScaffoldVuer',
         fileName: 'scaffoldvuer',
       },
       rollupOptions: {
         external: [
-          "vue",
-          "@abi-software/sparc-annotation",
-          "@abi-software/svg-sprite",
-          "@abi-software/map-utilities",
-          "pinia",
-          "@abi-software/map-utilities/dist/style.css"
+          'vue',
+          '@abi-software/sparc-annotation',
+          '@abi-software/svg-sprite',
+          '@abi-software/map-utilities',
+          'pinia',
+          '@abi-software/map-utilities/dist/style.css',
         ],
         output: {
           globals: {
-            vue: "Vue",
-            "@abi-software/sparc-annotation": "@abi-software/sparc-annotation",
-            "@abi-software/svg-sprite": "@abi-software/svg-sprite",
-            "@abi-software/map-utilities": "@abi-software/map-utilities",
-            "pinia": "pinia"
+            vue: 'Vue',
+            '@abi-software/sparc-annotation': '@abi-software/sparc-annotation',
+            '@abi-software/svg-sprite': '@abi-software/svg-sprite',
+            '@abi-software/map-utilities': '@abi-software/map-utilities',
+            '@abi-software/map-utilities/dist/style.css':
+              '_abi_software_map_utilities_dist_style_css',
+            pinia: 'pinia',
           },
           // keep css output name stable for the "./dist/style.css" export/import paths
           assetFileNames: (assetInfo) =>
-            assetInfo.name?.endsWith(".css")
-              ? "style.css"
-              : "assets/[name][extname]",
+            assetInfo.name?.endsWith('.css') ? 'style.css' : 'assets/[name][extname]',
         },
       },
     },
   };
 
   if (command === 'serve') {
-    config.server =  {
+    config.server = {
       port: 8081,
     };
     config.define = {
@@ -85,9 +86,9 @@ export default defineConfig(({ command, mode }) => {
     config.plugins.push(
       nodePolyfills({
         // To add only specific polyfills, add them here. If no option is passed, adds all polyfills
-        include: ['path']
-      })
+        include: ['path'],
+      }),
     );
-  };
+  }
   return config;
-})
+});

package/vite.static-build.js

@@ -1,18 +1,18 @@
-import { defineConfig } from 'vite'
-import rootConfig from './vite.config.js'
-import { nodePolyfills } from 'vite-plugin-node-polyfills'
+import { defineConfig } from 'vite';
+import rootConfig from './vite.config.js';
+import { nodePolyfills } from 'vite-plugin-node-polyfills';
 
 // defineWorkspace provides a nice type hinting DX
 export default defineConfig((configEnv) => {
   const config = rootConfig(configEnv);
   config.build = {
-    outDir: "test-html"
+    outDir: 'test-html',
   };
   config.plugins.push(
     nodePolyfills({
       // To add only specific polyfills, add them here. If no option is passed, adds all polyfills
-      include: ['path']
-    })
+      include: ['path'],
+    }),
   );
   return config;
-})
+});

package/vuese-generator.js

@@ -5,120 +5,112 @@
  * To watch components changes for Vitepress on Dev Mode
  */
 
-import fs from 'fs'
-import path from 'path'
-import chokidar from 'chokidar'
+import fs from 'fs';
+import path from 'path';
+import chokidar from 'chokidar';
 // import { parser } from '@vuese/parser'
-import { parseSource } from 'vue-docgen-api'
-import { Render } from '@vuese/markdown-render'
+import { parseSource } from 'vue-docgen-api';
+import { Render } from '@vuese/markdown-render';
 
-const watchMode = process.argv.find((argv) => argv === 'watch')
+const watchMode = process.argv.find((argv) => argv === 'watch');
 
-const componentsDir = 'src/components'
-const components = ['ScaffoldVuer.vue']
-const outputDir = 'docs/components'
+const componentsDir = 'src/components';
+const components = ['ScaffoldVuer.vue'];
+const outputDir = 'docs/components';
 
 function generateMarkdown(file) {
-  const fileWithPath = `${componentsDir}/${file}`
-  const fileContent = fs.readFileSync(fileWithPath, 'utf-8')
+  const fileWithPath = `${componentsDir}/${file}`;
+  const fileContent = fs.readFileSync(fileWithPath, 'utf-8');
 
   try {
     // const parserResult = parser(fileContent)
-    const parserResult = parseSource(fileContent, fileWithPath)
+    const parserResult = parseSource(fileContent, fileWithPath);
     parserResult.then((result) => {
-      const {
-        displayName: name,
-        description: desc,
-        props,
-        events,
-        methods
-      } = result
+      const { displayName: name, description: desc, props, events, methods } = result;
 
       // transform props to vuese styles
       const parseResult = {
         name: name,
         componentDesc: {
-          default: [desc]
+          default: [desc],
         },
         props: transformData(props),
         events: transformData(events),
         methods: transformData(methods),
-      }
-      const r = new Render(parseResult)
-      const renderResult = r.render()
-      const markdownResult = r.renderMarkdown()
-      const markdownContent = markdownResult.content
-      const componentName = path.basename(fileWithPath, '.vue')
+      };
+      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)
+        fs.mkdirSync(outputDir);
       }
 
       fs.writeFile(`${outputDir}/${componentName}.md`, markdownContent, (err) => {
         if (err) {
-          console.error(`Error writing markdown file for ${componentName}`, err)
+          console.error(`Error writing markdown file for ${componentName}`, err);
         } else {
-          console.log(`Markdown file for ${componentName} is generated!`)
+          console.log(`Markdown file for ${componentName} is generated!`);
         }
-      })
-    })
-  } catch(e) {
-    console.error(e)
+      });
+    });
+  } catch (e) {
+    console.error(e);
   }
 }
 
 function transformData(data = []) {
   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) {
-      prop.type = prop.type.name
+      prop.type = 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);
+      });
     }
-  })
-  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)
-  })
-}
+    console.log(`The component ${file} has changed!`);
+    generateMarkdown(file);
+  });
+}