Bootstrap-Vue Vetur Intellisense Definitions

1.1.1 · abandoned · verified Sun Apr 19

This package, `bootstrap-vue-helper-json`, was originally designed to provide Vetur intellisense reference definitions for Bootstrap-Vue components. Its primary purpose was to enhance developer experience by offering auto-completion and documentation hints within IDEs like VS Code when working with Bootstrap-Vue and the Vetur extension. However, starting with Bootstrap-Vue v2.1, this helper's functionality was directly integrated into the main Bootstrap-Vue package itself. Consequently, `bootstrap-vue-helper-json` became obsolete and its GitHub repository was archived in November 2019. Developers using Bootstrap-Vue v2.1 or newer should rely on the `dist/vetur-tags.json` and `dist/vetur-attributes.json` files provided by the core `bootstrap-vue` package for Vetur support. The original `bootstrap-vue` library (for Vue 2 and Bootstrap 4) is now largely in maintenance mode, with `BootstrapVueNext` serving as the modern successor for Vue 3 and Bootstrap 5.

Common errors

```
Vetur: Cannot find Vetur component data in package.json for 'bootstrap-vue-helper-json'
```
cause This error occurs because Vetur is looking for component data within a package that is either obsolete, not configured correctly, or whose functionality has been moved.

fix If you are using `bootstrap-vue` v2.1 or newer, remove `bootstrap-vue-helper-json` as a dependency. Ensure your project's `package.json` correctly points Vetur to the definitions within the `bootstrap-vue` package itself (e.g., `"vetur": {"tags": "node_modules/bootstrap-vue/dist/vetur-tags.json", "attributes": "node_modules/bootstrap-vue/dist/vetur-attributes.json"}`).

Warnings

breaking The functionality provided by `bootstrap-vue-helper-json` was integrated directly into the `bootstrap-vue` package itself starting from version v2.1. Installing and using this separate helper package is redundant and can lead to conflicts or outdated intellisense for Bootstrap-Vue versions v2.1 and newer.
Fix: Remove `bootstrap-vue-helper-json` from your project dependencies. `bootstrap-vue` automatically includes the necessary Vetur definition files (`dist/vetur-tags.json` and `dist/vetur-attributes.json`). Ensure your `package.json` correctly points to these files if Vetur isn't detecting them automatically.
deprecated This package's GitHub repository was archived in November 2019 and is no longer maintained. Furthermore, the `bootstrap-vue` library (which this helper supported) is largely superseded by `BootstrapVueNext` for projects using Vue 3 and Bootstrap 5. `bootstrap-vue` itself is primarily for Vue 2 and Bootstrap 4.
Fix: Do not use this package. For new projects or migrations to Vue 3/Bootstrap 5, consider `BootstrapVueNext` which provides its own modern intellisense support. For existing Vue 2/Bootstrap 4 projects, rely on the intellisense files provided by the `bootstrap-vue` package itself.

Install

npm install bootstrap-vue-helper-json npm
yarn add bootstrap-vue-helper-json yarn
pnpm add bootstrap-vue-helper-json pnpm

Quickstart

This shows a `package.json` configuration for Vetur to correctly pick up Bootstrap-Vue's intellisense definitions directly from the `bootstrap-vue` package, making this helper package obsolete. This is for Vue 2/Bootstrap 4 setups.

{
  "name": "my-vue2-bootstrap-app",
  "version": "0.1.0",
  "private": true,
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build"
  },
  "dependencies": {
    "bootstrap": "^4.6.0",
    "bootstrap-vue": "^2.23.0",
    "core-js": "^3.8.3",
    "vue": "^2.6.14",
    "vue-router": "^3.5.1",
    "vuex": "^3.6.2"
  },
  "devDependencies": {
    "@vue/cli-service": "~5.0.0",
    "vue-template-compiler": "^2.6.14"
  },
  "vetur": {
    "tags": "node_modules/bootstrap-vue/dist/vetur-tags.json",
    "attributes": "node_modules/bootstrap-vue/dist/vetur-attributes.json"
  }
}

view raw JSON →