Skip to content

Commit

Permalink
chore: add comment for making .vue files lint working
Browse files Browse the repository at this point in the history
  • Loading branch information
Kocal authored Oct 18, 2019
1 parent 6c35a2d commit 7ff495d
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -1063,7 +1063,7 @@ class Encore {
* Encore.enableEslintLoader(() => {}, {
* // set optional Encore-specific options, for instance:
*
* // lint `.vue` files
* // lint `.vue` files, see below for more informatin about linting Vue files
* lintVue: true
* });
* ```
Expand All @@ -1072,6 +1072,18 @@ class Encore {
* * {boolean} lintVue (default=false)
* Configure the loader to lint `.vue` files
*
* // Linting Vue files
* Encore.enableEslintLoader((options) => {
* // Deleting the hard-coded `parser` option prevent the error "Use the latest vue-eslint-parser", see:
* // - https://eslint.vuejs.org/user-guide/#what-is-the-use-the-latest-vue-eslint-parser-error
* // - https://github.com/symfony/webpack-encore/pull/574
* // Note that it will not be mandatory anymore is some times.
* delete options.parser;
* }, {
* lintVue: true
* });
* ```
*
* @param {string|object|function} eslintLoaderOptionsOrCallback
* @param {object} encoreOptions
* @returns {Encore}
Expand Down

0 comments on commit 7ff495d

Please sign in to comment.