feat(api): fill "meta" > docsUrl prop; build improvements

Author: rstoenescu

app/bin/quasar-describe

@@ -483,6 +483,7 @@ function describe (api) {
       apiParts.methods === true && printMethods(api)
       break
   }
+
   if (apiParts.docs && api.meta && api.meta.docsUrl) {
     openBrowser(api.meta.docsUrl)
   }

ui/build/build.api.js

@@ -2,8 +2,7 @@ const
   glob = require('glob'),
   path = require('path'),
   merge = require('webpack-merge'),
-  fs = require('fs'),
-  request = require('request')
+  fs = require('fs')
 
 const
   root = path.resolve(__dirname, '..'),
@@ -38,8 +37,8 @@ function getMixedInAPI (api, mainFile) {
 
 const topSections = {
   plugin: [ 'meta', 'injection', 'quasarConfOptions', 'props', 'methods' ],
-  component: ['meta', 'behavior', 'props', 'slots', 'scopedSlots', 'events', 'methods'],
-  directive: ['meta', 'value', 'arg', 'modifiers']
+  component: [ 'meta', 'behavior', 'props', 'slots', 'scopedSlots', 'events', 'methods' ],
+  directive: [ 'meta', 'value', 'arg', 'modifiers' ]
 }
 
 const objectTypes = {
@@ -119,7 +118,7 @@ const objectTypes = {
   },
 
   meta: {
-    props: [ 'docsRoute', 'docsPage', 'docsApiAnchor' ],
+    props: [ 'docsUrl' ],
     required: []
   },
 
@@ -220,7 +219,6 @@ function parseObject ({ banner, api, itemName, masterType, verifyCategory }) {
     }
 
     if (!def.props.includes(prop)) {
-      console.log(def)
       logError(`${banner} object has unrecognized API prop "${prop}" for its type (${type})`)
       console.error(obj)
       console.log()
@@ -350,28 +348,18 @@ function parseAPI (file, apiType) {
       continue
     }
 
-    if (['value', 'arg', 'quasarConfOptions'].includes(type)) {
+    if (['value', 'arg', 'quasarConfOptions', 'meta'].includes(type)) {
       if (Object(api[type]) !== api[type]) {
         logError(`${banner} "${type}"/"${type}" is not an object`)
         process.exit(1)
       }
     }
 
-    if (type === 'quasarConfOptions') {
+    if (['meta', 'quasarConfOptions'].includes(type)) {
       parseObject({
         banner: `${banner} "${type}"`,
         api,
-        itemName: 'quasarConfOptions',
-        masterType: type
-      })
-      continue
-    }
-
-    if (type === 'meta') {
-      parseObject({
-        banner: `${banner} "${type}"`,
-        api,
-        itemName: 'meta',
+        itemName: type,
         masterType: type
       })
       continue
@@ -403,33 +391,7 @@ function parseAPI (file, apiType) {
   return api
 }
 
-const routes = {
-  component: 'vue-components',
-  directive: 'vue-directives',
-  plugin: 'quasar-plugins'
-}
-
-function getPage (fileName) {
-  let page
-  if (fileName.startsWith('Q')) {
-    page = fileName.slice(1)
-  }
-  else {
-    page = fileName
-  }
-  // kebab-case
-  return page.replace(/([a-z])([A-Z])/g, '$1-$2').replace(/[\s_]+/g, '-').toLowerCase()
-}
-
-function orderAPI (api, apiType, fileName) {
-  const metaDef = api.meta || {},
-    meta = {},
-    docsApiAnchor = metaDef.docsApiAnchor === void 0
-      ? (apiType === 'directive' ? 'API' : fileName + '-API')
-      : metaDef.docsApiAnchor
-  // TODO change URL to v1.quasar.dev
-  meta.docsUrl = `https://quasar.dev/${metaDef.docsRoute || routes[apiType]}/${metaDef.docsPage || getPage(fileName)}#${docsApiAnchor}`
-
+function orderAPI (api, apiType) {
   const ordered = {
     type: apiType
   }
@@ -440,8 +402,6 @@ function orderAPI (api, apiType, fileName) {
     }
   })
 
-  ordered.meta = meta
-
   return ordered
 }
 
@@ -489,7 +449,7 @@ function fillAPI (apiType) {
       name = path.basename(file),
       filePath = path.join(dest, name)
 
-    const api = orderAPI(parseAPI(file, apiType), apiType, name.replace('.json', ''))
+    const api = orderAPI(parseAPI(file, apiType), apiType)
 
     if (apiType === 'component') {
       const definition = fs.readFileSync(file.replace('.json', '.js'), {

ui/src/components/ajax-bar/QAjaxBar.json

@@ -1,4 +1,8 @@
 {
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/ajax-bar"
+  },
+
   "props": {
     "position": {
       "type": "String",

ui/src/components/avatar/QAvatar.json

@@ -1,6 +1,10 @@
 {
   "mixins": [ "mixins/size" ],
 
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/avatar"
+  },
+
   "behavior": {
     "$listeners": true
   },

ui/src/components/badge/QBadge.json

@@ -1,4 +1,8 @@
 {
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/badge"
+  },
+
   "behavior": {
     "$listeners": true
   },

ui/src/components/banner/QBanner.json

@@ -1,4 +1,8 @@
 {
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/banner"
+  },
+
   "behavior": {
     "$listeners": true
   },

ui/src/components/bar/QBar.json

@@ -1,4 +1,8 @@
 {
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/bar"
+  },
+
   "behavior": {
     "$listeners": true
   },

ui/src/components/breadcrumbs/QBreadcrumbs.json

@@ -1,4 +1,8 @@
 {
+  "meta": {
+    "docsUrl": "https://v1.quasar.dev/vue-components/breadcrumbs"
+  },
+
   "behavior": {
     "$listeners": true
   },

ui/src/components/breadcrumbs/QBreadcrumbsEl.json

@@ -1,6 +1,6 @@
 {
   "meta": {
-    "docsPage": "breadcrumbs"
+    "docsUrl": "https://v1.quasar.dev/vue-components/breadcrumbs"
   },
 
   "mixins": [ "mixins/router-link" ],

ui/src/components/btn-dropdown/QBtnDropdown.json

@@ -2,7 +2,7 @@
   "mixins": [ "mixins/btn", "mixins/model-toggle" ],
 
   "meta": {
-    "docsPage": "button-dropdown"
+    "docsUrl": "https://v1.quasar.dev/vue-components/button-dropdown"
   },
 
   "props": {