eslint-config-superology-vue

Shared ESLint config for Vue based projects at Superology.

ESLint statically analyzes your code to quickly find problems. ESLint is built into most text editors and you can run ESLint as part of your continuous integration pipeline.

• Getting Started
• Configuring
• Rules
• Shareable Configs

Usage

Install the configuration

npm install eslint-config-superology-vue --save-dev

Also make sure you have peer dependencies installed:

npm install eslint prettier jest eslint-plugin-import --save-dev

Add to ESLint configuration

{
  "extends": "eslint-config-superology-vue"
}

Using .eslintrc file

or

module.exports = {
  extends: "eslint-config-superology-vue",
};

if using .eslintrc.js file

Handling browser compatibility

It's recommended to update your package.json with browsers you intend to support using browserslist. The defaults for Superology would be:

{
    "browserslist": [
        "last 2 versions",
        "not dead",
        "not ie >= 0",
        "not op_mini all",
        "not op_mob >= 0"
  ]
}

You can then check the supported browsers by running npx browserslist.

If you still receive compatibility warnings for browsers that you are not supporting, it's possible that some npm package is superseding your eslint config with it's own config. To make sure that your browserslist is respected, override the targets in your eslintrc config with:

{
    "settings": {
        "targets": null
    }
}

Suggestions?

Create a discussion on GitHub or learn how to make a contribution.