README

gandalf-lint-vue

BAD VUE CODE SHALL NOT PASS!

Install

Install the most powerful linter of the middle-earth (and its dependencies):

Dependencies via NPM:

npm install --save-dev @softboxlab/eslint-config-gandalf-lint @softboxlab/eslint-config-gandalf-lint-vue eslint babel-eslint eslint-plugin-vue

or via yarn:

yarn add --dev @softboxlab/eslint-config-gandalf-lint @softboxlab/eslint-config-gandalf-lint-vue eslint babel-eslint eslint-plugin-vue

Requirements

ESLint ^5.0.0.
eslint-plugin-vue ^5.0.0.
gandalf-lint ^0.2.1.
Node.js >=6.5.0

Configure

Call the white wizard by creating a .eslintrc file on your root project and writing in it:

{
  "extends": [
    "@softboxlab/eslint-config-gandalf-lint-vue"
  ],
  "parserOptions": {
    "parser": "babel-eslint"
  }
}

Remember to add the eslint plugin on your favorite IDE, like this one: ESLint for VSCode

Usage

If you want you can create a script on your package.json file like so:

"scripts": {
  "glint": "eslint {YOUR_SOURCE_FOLDER} --ext .js,.vue"
}

And use your magic script for shall not pass any bad code:

npm run glint

or using yarn:

yarn glint

Tips

To ignore some files from being linted just add them to a .eslintignore file

Autorun? Automatic lint?

If you don't fell like creating any scripts, feel free to have your files linted on the fly by your IDE (did you remember to install the eslint plugin on your IDE?)

Gandalf approves

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This project licence is also MIT.

Usage no npm install needed!