ESLint Config Pixel

Strict ESLint configuration with Prettier included maintained by Pixel Perfect Agency.

Rationale

This package is designed for usage with Next.js, React, TypeScript and Prettier.

We want to have a strict ESLint configuration that is consistent across projects. We also want to use Prettier to format our code. This package implements the configuration we use in our projects.

⚠️Note: This configuration is only recommended for individuals or teams which consist of very proficient Typescript developers, please take this into consideration (rules)

Installation

npm install --save-dev eslint-config-pixel

Usage

Add this to your .eslintrc file:

You can use a lot of different configuration files, view the ESLint documentation for more information.

package.json

{
    "eslintConfig": {
        "extends": "pixel"
    }
}

.eslintrc

{
    "extends": "pixel"
}

You only need to provide the word pixel to the extends property. Eslint will automatically look for the eslint-config-pixel package.

You can also add your own rules to the configuration file.

{
    "extends": "pixel",
    "rules": {
        "no-console": "off"
    }
}

Prettier

This package also includes a complementing Prettier config, you can use it by adding the following to your package.json file:

{
    "prettier": "eslint-config-pixel/prettier"
}

If you want to customize properties of the Prettier config, you can do so by adding a configuration file to your project root. You can find more information about this here.

module.exports = {
    ...require('eslint-config-pixel/prettier'),
    // Specifies the order of imports and sorts them automatically.
    // Great for usage with Typescript absolute paths.
    importOrder: [
        '^react$',
        '^next$',
        '<THIRD_PARTY_MODULES>',
        '^~components/(.*)$',
        '^~hooks/(.*)$',
        '^~styles/(.*)$',
        '^~types/(.*)$',
        '^~/(.*)$',
        '^[./]',
    ],
};

Rules

This package extends the following packages:

• eslint-config-prettier
• eslint-plugin-react
• typescript-eslint

@typescript-eslint/eslint-plugin includes over 100 rules that detect best practice violations, bugs, and/or stylistic issues specifically for TypeScript code. You can find the full list of rules here

Examples

As mentioned before, some of the rules that are included in this package are very strict and should only be used by very proficient Typescript developers. If you don't have a lot of experience with Typescript & Javascript, you should probably use a different, less strict configuration. If you do not have a lot of experience these rules will probably be very annoying and you will not fully understand why they are there, also, if you are creating a simple side project these rules will probably be overkill and make you less productive.

@typescript-eslint/prefer-for-of

// Bad
const array = [1, 2, 3, 4, 5];
for (let i = 0; i < array.length; i++) {
    console.log(array[i]);
}

// Good
const array = [1, 2, 3, 4, 5];
for (const element of array) {
    console.log(element);
}

@typescript-eslint/no-floating-promises

// Bad
const promise = async () => {
    return await new Promise(resolve => {
        setTimeout(() => {
            resolve();
        }, 2000);
    });
};

promise();

// Good
const promise = async () => {
    return await new Promise(resolve => {
        setTimeout(() => {
            resolve();
        }, 2000);
    });
};

const result = await promise();

if (result) // do something

There are a lot of rules like this which enforce good practices and prevent bugs, however they take some time to get used to and to understand.

Contributing

Contributions are always welcome! Please understand that this package is maintained by Pixel Perfect Agency and we will only accept contributions that we feel are in line with our vision for this package.

License

MIT © Pixel Perfect Agency 2023