eslint-config-superology-vue-typescript

Shared ESLint config for Vue based projects at Superology using TypeScript.

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-typescript --save-dev

Also make sure you have peer dependencies installed, they should be automatically installed by npm, but it's good to double check:

npm install eslint prettier jest eslint-plugin-import eslint-config-superology-vue @rushstack/eslint-patch --save-dev

IMPORTANT

This plugin really requires eslint-config-superology-vue to work correctly and to apply full Superology linting rules.

Add to ESLint configuration

Using .eslintrc file:

If you don't need to support JavaScript files, all you have to do is to extend eslint-config-superology-vue-typescript:

{
    "extends": [
        "eslint-config-superology-vue-typescript"
    ]
}

Otherwise, you'll have to configure overrides:

{
    "overrides": [
        // This override is only needed if your project actually has non-TypeScript files
        {

            "files": [
                "*.js"
            ],
            "extends": [
                "eslint-config-superology-vue"
            ]
        },
        {
            "files": [
                "*.vue",
                "*.tsx",
                "*.ts"
            ],
            "extends": [
                "eslint-config-superology-vue-typescript"
            ]
        }
    ]
}

Suggestions?

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