refactor: add docs link to prop hints, add package.json script

woothu · woothu · commit dc380d4b6de6 · 2020-01-10T13:00:21.000+01:00
diff --git a/build/buildVscodeHints.js b/build/buildVscodeHints.js
@@ -87,15 +87,15 @@ function generateAttributes (content) {
         const key = name + '/' + propName
         const kebabKey = toKebabCase(name) + '/' + propName
         const type = prop.split(':')[1].trim()
-        const description = ''
+        const description = 'For API documentation please visit https://coreui.io/vue/docs'
 
         attributes[kebabKey] = {
+          description,
           type,
-          description
         }
         attributes[key] = {
+          description,
           type,
-          description
         }
       })
     }
diff --git a/dist/vetur/coreui-attributes.json b/dist/vetur/coreui-attributes.json
diff --git a/package.json b/package.json
@@ -62,7 +62,8 @@
     "test": "vue-cli-service test:unit",
     "test:coverage": "vue-cli-service test:unit --coverage",
     "clearCache": "jest --clearCache",
-    "release": "npm-run-all clearCache lint build test:coverage",
+    "release": "npm-run-all clearCache lint build test:coverage generate-hints",
+    "generate-hints": "node build/buildVscodeHints.js",
     "auto-changelog": "auto-changelog --template changelog-template.hbs --commit-limit false --package"
   },
   "dependencies": {

Original file line number	Diff line number	Diff line change
`@@ -87,15 +87,15 @@ function generateAttributes (content) {`
`87`	`87`	`const key = name + '/' + propName`
`88`	`88`	`const kebabKey = toKebabCase(name) + '/' + propName`
`89`	`89`	`const type = prop.split(':')[1].trim()`
`90`		`- const description = ''`
	`90`	`+ const description = 'For API documentation please visit https://coreui.io/vue/docs'`
`91`	`91`
`92`	`92`	`attributes[kebabKey] = {`
	`93`	`+ description,`
`93`	`94`	`type,`
`94`		`- description`
`95`	`95`	`}`
`96`	`96`	`attributes[key] = {`
	`97`	`+ description,`
`97`	`98`	`type,`
`98`		`- description`
`99`	`99`	`}`
`100`	`100`	`})`
`101`	`101`	`}`