@abi-software/map-side-bar 2.4.1 → 2.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abi-software/map-side-bar",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "files": [
     "dist/*",
     "src/*",
@@ -38,23 +38,22 @@
     "./src/*": "./src/*"
   },
   "dependencies": {
-    "@abi-software/gallery": "^1.1.1",
-    "@abi-software/map-utilities": "^1.1.0",
-    "@abi-software/svg-sprite": "^1.0.0",
+    "@abi-software/gallery": "^1.1.2",
+    "@abi-software/map-utilities": "^1.1.2",
+    "@abi-software/svg-sprite": "^1.0.1",
     "@element-plus/icons-vue": "^2.3.1",
     "algoliasearch": "^4.10.5",
-    "element-plus": "^2.5.3",
+    "element-plus": "2.8.4",
     "marked": "^4.1.1",
     "mitt": "^3.0.1",
     "unplugin-vue-components": "^0.26.0",
-    "vue": "^3.3.13",
+    "vue": "^3.4.21",
     "xss": "^1.0.14"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^4.6.2",
     "@vue/compiler-sfc": "^3.3.13",
     "@vuese/markdown-render": "^2.11.3",
-    "@vuese/parser": "^2.10.3",
     "auto-changelog": "^2.4.0",
     "autoprefixer": "^10.4.17",
     "chokidar": "^3.6.0",
@@ -64,7 +63,6 @@
     "cypress-wait-until": "^3.0.1",
     "eslint": "^8.56.0",
     "eslint-plugin-vue": "^9.19.2",
-    "file-loader": "^5.0.2",
     "mochawesome": "^7.1.3",
     "raw-loader": "^0.5.1",
     "sass": "^1.70.0",
@@ -73,6 +71,6 @@
     "vite": "^5.0.10",
     "vitepress": "^1.0.2",
     "vue-custom-element": "^3.3.0",
-    "webpack-node-externals": "^2.5.2"
+    "vue-docgen-api": "^4.79.2"
   }
 }

package/src/components/SideBar.vue

@@ -162,15 +162,15 @@ export default {
       this.$emit('search-changed', { ...data, id: id })
     },
     /**
-     * @vuese
      * The function to close sidebar.
+     * @public
      */
     close: function () {
       this.drawerOpen = false
     },
     /**
-     * @vuese
      * The function to toggle (open and close) sidebar.
+     * @public
      */
     toggleDrawer: function () {
       this.drawerOpen = !this.drawerOpen
@@ -212,9 +212,10 @@ export default {
       return this.$refs[searchTabRefId][0];
     },
     /**
-     * @vuese
      * The function to add filters to sidebar search.
-     * @arg filter `object`
+     *
+     * @param {Object} filter
+     * @public
      */
     addFilter: function (filter) {
       this.drawerOpen = true
@@ -247,15 +248,15 @@ export default {
       this.drawerOpen = value
     },
     /**
-     * @vuese
      * The function to emit 'tabClicked' event with tab's `id` and tab's `type`
      * when user clicks the sidebar tab.
-     * @arg {id, type}
+     * @param {Object} {id, type}
+     * @public
      */
     tabClicked: function ({id, type}) {
       /**
        * This event is emitted when user click sidebar's tab.
-       * @arg {id, type}
+       * @arg {Object} {id, type}
        */
       this.$emit('tabClicked', {id, type});
     },

package/vuese-generator.js

@@ -8,7 +8,8 @@
 import fs from 'fs'
 import path from 'path'
 import chokidar from 'chokidar'
-import { parser } from '@vuese/parser'
+// import { parser } from '@vuese/parser'
+import { parseSource } from 'vue-docgen-api'
 import { Render } from '@vuese/markdown-render'
 
 const watchMode = process.argv.find((argv) => argv === 'watch')
@@ -22,29 +23,87 @@ function generateMarkdown(file) {
   const fileContent = fs.readFileSync(fileWithPath, 'utf-8')
 
   try {
-    const parserResult = parser(fileContent)
-    const r = new Render(parserResult)
-    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 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),
+      }
+      const r = new Render(parseResult)
+      const renderResult = r.render()
+      const markdownResult = r.renderMarkdown()
+      const markdownContent = markdownResult.content
+      const componentName = path.basename(fileWithPath, '.vue')
 
-    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!`)
+      if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir)
       }
+
+      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)
   }
 }
 
+function transformData(data) {
+  data.forEach((prop) => {
+    prop.name = prop.name
+
+    if (prop.description) {
+      prop.describe = [prop.description.replaceAll('\n', ' ')]
+    }
+
+    if (prop.type) {
+      prop.type = prop.type.name
+    }
+
+    if (prop.defaultValue) {
+      prop.default = prop.defaultValue.value.replaceAll('\n', ' ')
+    }
+
+    // events
+    if (prop.properties) {
+      prop.argumentsDesc = []
+      prop.properties.forEach((param) => {
+        const argName = param.name || param.description
+        prop.argumentsDesc.push(argName)
+      })
+    }
+
+    // methods
+    if (prop.params) {
+      prop.argumentsDesc = []
+      prop.params.forEach((param) => {
+        const argName = param.name || param.description
+        prop.argumentsDesc.push(argName)
+      })
+    }
+  })
+  return data
+}
+
 // To generate markdown files - one time
 components.forEach((component) => {
   console.log(`Write markdown file for ${component} on first load.`)