README.md

ESLint + Prettier + Tailwind Config for Next.js

Shareable config for ESLint, Prettier and Tailwind, aimed primarily to be used in NextJS projects.

Overview

This configuration extends some recommended ESLint config, Prettier and Tailwind integration via the ESLint eslint-plugin-prettier and eslint-plugin-tailwindcss. Additionally, a few default rules are overriden to provide a more relaxed development experience in Next.js applications out of the box.

The goal of this configuration is to get code linting and formatting up and running as quickly as possible in a modern development environment, without sacrificing cleanliness and readability, and having to configure ESLint + Prettier from scratch every time.

Installation

To install the package, run:

npm install --save-dev @cesiuminho/eslint-config

This will install the shared config

• eslint
• prettier
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-config-prettier
• eslint-plugin-tailwindcss
• eslint-plugin-import
• eslint-plugin-unused-imports

Usage

To start using this shared config, add @cesiuminho/eslint-config to the .eslintrc file:

// .eslintrc
{
  "extends": "@cesiuminho/eslint-config/next"
}

Prettier

This config supports Prettier integration out of the box. Rules that may conflict with ESLint are disabled via recommended configuration in eslint-plugin-prettier.

If you wish to override any Prettier options, you can do so by specifying them under prettier/prettier rule in your ESLint config file. For example:

// .eslintrc
{
  "extends": "@cesiuminho/eslint-config/next",
  "rules": {
    "prettier/prettier": [
      "error",
      {
        "semi": false
      }
    ]
  }
}

Make sure that these rules match the options specified in your .prettierrc file.

Adding Scripts

Add the following to your package.json file to define a script that will lint all known files and output the results:

// package.json
{
  "scripts": {
    "lint": "next lint"
  }
}

To fix all automatically-fixable issues, you can add the following script to your package.json as well (in addition to above):

// package.json
{
  "scripts": {
    "lint:fix": "next lint --fix"
  }
}

Note that you can update the above scripts as you see fit, this is just an example. See ESLint CLI reference for more details.

Author

CeSIUM

License

MIT