Skip to content
Permalink
Browse files

feat: auto-generate file `web-types.json` for WebStorm, and files `ve…

…tur-tags.json` and `vetur-attributes.json` for Vetur (closes #4107) (#4110)
  • Loading branch information
tmorehouse committed Oct 15, 2019
1 parent 25dacb5 commit 1a3e6a56759bee9cc11d4405a4708dbba826fa51
Showing with 491 additions and 3 deletions.
  1. +9 −2 docs/markdown/intro/README.md
  2. +6 −1 package.json
  3. +5 −0 scripts/build.sh
  4. +471 −0 scripts/create-web-types.js
@@ -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.
@@ -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",
@@ -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.'

0 comments on commit 1a3e6a5

Please sign in to comment.
You can’t perform that action at this time.