uicrooks / shopify-theme-lab

Shopify theme development environment using Liquid, Vue and Tailwind CSS. Built on top of Shopify CLI 🧪
https://uicrooks.github.io/shopify-theme-lab-docs/
MIT License
737 stars 130 forks source link

Add https://eslint.vuejs.org/rules/ to .eslintrc.js #55

Closed james0r closed 3 years ago

james0r commented 3 years ago

Was a bit verbose for me out of the box figuring that the VSCode Vetur formatting doesn't clean most of this stuff up.

Might be helpful to have this link in there, took me a few minutes to find it.

sergejcodes commented 3 years ago

Hi 👋,

can you elaborate a bit. Are you using the Vetur extension to automatically fix any fixable errors inside your Vue files? Or are you using the lint task inside package.json and are adding the --fix flag?

Since not everyone is going to use Vetur it might be better to add a notice and link to the ESLint docs inside .eslintrc.js. Would something like this be helpful?

/*
 * by running 'npm run lint:js -- --fix' in the command line ESLint can automatically fix some of the reported problems
 * see https://eslint.org/docs/rules for more details
 */

...
james0r commented 3 years ago

Ya I'm using Vetur but I'm more talking about the console output.

Just kinda flooded with linting warnings out the box when not following the formatting rules.

I was tipped off by the existing comment regarding eslint rules and then googled my way to the Vue specific rules which I ended up using to reduce the linting warnings by going with vue/essential.

sergejcodes commented 3 years ago

Alright, I think appending an additional comment with instructions for the essential rules after plugin:vue/recommended should do it:

module.exports = {
  extends: [
    'eslint:recommended',
    'plugin:vue/recommended' // use 'plugin:vue/essential' for less strict linting rules - https://eslint.vuejs.org/rules
  ],
  ...
}
sergejcodes commented 3 years ago

The latest v2.4.14 release now implements this notice in .eslintrc.js 95e249a94eb4881209e2f91e33a1b2992ca5afd5