@fimbul/ve

Vue processor for wotan

Usage no npm install needed!

<script type="module">
  import fimbulVe from 'https://cdn.skypack.dev/@fimbul/ve';
</script>

README

Vé

Wotan processor for Vue Single File Components (SFC)

npm version npm downloads Renovate enabled CircleCI Build status codecov Join the chat at https://gitter.im/fimbullinter/wotan

Make sure to also read the full documentation of all available modules.

Purpose

Enable wotan to lint *.vue files. This works by extracting the <script> content of a single file component and feeding that into TypeScript. The lang attribute is respected and defaults to js if not present. You can use every language TypeScript supports (currently js, jsx, ts, tsx). It even works with type checking.

Installation

npm install --save-dev @fimbul/wotan @fimbul/ve
# or
yarn add -D @fimbul/wotan @fimbul/ve

Usage

Use as processor in your config:

---
overrides:
  - files: "*.vue"
    processor: "@fimbul/ve"

There's also a configuration preset you can extend. This preset comes without any enabled rules and just provides the processor for *.vue files as described above.

---
extends:
  - "@fimbul/ve"

License

Apache-2.0 © Klaus Meinhardt