feat: auto-generate file web-types.json for WebStorm, and files vetur-tags.json and vetur-attributes.json for Vetur (closes #4107) (#4110)

tmorehouse · web-flow · commit 1a3e6a56759b · 2019-10-15T12:54:26.000-03:00
diff --git a/docs/markdown/intro/README.md b/docs/markdown/intro/README.md
@@ -742,8 +742,15 @@ above for an example.
 
 ## Tooling support
 
+BootstrapVue provides additional helper files for auto completion in popular IDE editors.
+
 ### VS Code + Vetur
 
 If you are using [VS Code](https://code.visualstudio.com/) as your text editor, BootstrapVue has
-intellisense autocompletion for component attributes available when using the
-[Vetur extension](https://marketplace.visualstudio.com/items?itemName=octref.vetur).
+intellisense autocompletion for component attributes and directives available via the
+`dist/vetur-tags.json` and `dist/vetur-attributes.json` files.
+
+### JetBrains WebStorm (and compatible)
+
+For [WebStorm](https://www.jetbrains.com/webstorm/) editor (or web-types compatible), BootstrapVue
+provides the file `dist/web-types.json` for component attribute and directive auto-completion.
diff --git a/package.json b/package.json
@@ -10,9 +10,14 @@
   "sass": "src/index.scss",
   "style": "dist/bootstrap-vue.css",
   "license": "MIT",
-  "types": "src/index.d.ts",
   "repository": "bootstrap-vue/bootstrap-vue",
   "homepage": "https://bootstrap-vue.js.org",
+  "types": "src/index.d.ts",
+  "web-types": "dist/web-types.json",
+  "vetur": {
+    "tags": "dist/vetur-tags.json",
+    "attributes": "dist/vetur-attributes.json"
+  },
   "contributors": [
     {
       "name": "Pooya Parsa",
diff --git a/scripts/build.sh b/scripts/build.sh
@@ -84,4 +84,9 @@ cd ..
 echo 'Done.'
 echo ''
 
+echo 'Building IDE auto-complete helper files...'
+node -r esm scripts/create-web-types.js || exit 1
+echo 'Done.'
+echo ''
+
 echo 'Done building assets.'
diff --git a/scripts/create-web-types.js b/scripts/create-web-types.js
