Skip to content

Commit b104cd5

Browse files
committed
Update docs
1 parent b65029e commit b104cd5

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/interpolation.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,27 @@ Vetur now offers completion, diagnostics, hover, jump to definition, find refere
1616

1717
## Generic Language Features
1818

19+
::: warning
20+
These features are experimental and you need to set `vetur.experimental.templateInterpolationService: true` to enable them. You can also only disable template diagnostics with `vetur.validation.template: false`, although that disables the built-in ESLint checking, too.
21+
:::
22+
1923
Currently diagnostics, hover, jump to definition and find references are implemented in this way:
2024

2125
- Compile original Vue template into a virtual TypeSript file
2226
- Generate a sourcemap between expressions in original `.vue` file and the virtual file
2327
- Run language feature requests on the virtual TypeScript file
2428
- Map results back to original `.vue` file
2529

26-
### Disabling
27-
28-
These features are still experimental. You can turn them off through `"vetur.experimental.templateInterpolationService"` or `vetur.validation.template`. Note that `vetur.validation.template` disables the built-in ESLint diagnostics, too.
30+
:::tip
31+
Use the command "Vetur: Show corresponding virtual file and sourcemap" to understand how the
32+
templates are represented in Vetur. Useful for bug filing too.
33+
:::
2934

3035
If you do find bugs, please [fill an issue](https://github.com/vuejs/vetur/issues).
3136

37+
If you want more details as to how this feature is implemented, I wrote a blog post: [Generic Vue Template Interpolation Language Features
38+
](https://blog.matsu.io/generic-vue-template-interpolation-language-features).
39+
3240
## Completion
3341

3442
Completion now works a little bit differently than the other language features. Mainly because completion works off a

0 commit comments

Comments
 (0)