@enhala/eslint-plugin-tsvue
v1.0.0
Published
ESLint plugin with support for Vue + TypeScript + Babel
Downloads
14
Maintainers
Readme
@enhala/eslint-plugin-tsvue
An eslint
plugin companion to Vue, TypeScript, and Babel. @enhala/eslint-plugin-tsvue
allows having Vue 3 or Vue 2.7 Single File Components with setup
and lang="ts"
, i.e. Options API, Composition API, all at the same time, mixed and matched, in one repository, and enables proper linting of all types of Components.
Enabling the plugin for ESLint, converts in the background SFCs with lang="ts"
filenames to .tsvue
extension, which then allows defining custom parsers. Regular JS SFCs will be processed as usuall, by eslint-plugin-vue
.
Note: the actual files don't change in any way, this is just for ESLint and further parsing within ESLint.
Inspired by mjeanroy/eslint-plugin-tsvue-sample.
Install
# npm
npm install -D @enhala/eslint-plugin-tsvue
# yarn
yarn add -D @enhala/eslint-plugin-tsvue
Use
To use, replace the vue
plugin with @enhala/tsvue
in plugins
array of your .eslintrc.js
.
Now that Vue SFCs with lang="ts"
have .tsvue
extensions, it's possible to define custom parsers, like @typescript-eslint/parser
by using overrides
.
// .eslintrc.js
module.exports = {
plugins: ['@babel', '@enhala/tsvue', '@typescript-eslint'],
overrides: [
{
files: ['*.tsvue'],
parserOptions: {
parser: '@typescript-eslint/parser',
extraFileExtensions: ['.tsvue'],
},
},
],
};
In case of @typescript-eslint/parser
, we have to also set parserOptions.extraFileExtensions
, so that parser won't ignore the file. With other parsers, please consult their documentation.
This works not only for TypeScript. For example, for lang="foo"
, the file extension would become .foovue
and it's possible to then set any parser using overrides.