Sirius Beck - ESLint Config

Installation

Install the package and its peer dependencies with npm or your favorite package manager as dev dependencies:

1npm install -D eslint@^8 prettier @siriusbeck/eslint-config

How to use

Eslint

Inside the .eslintrc file, extend @siriusbeck/eslint-config:

Basic

1{
2  "extends": "@siriusbeck/eslint-config"
3}

React

1{
2  "extends": "@siriusbeck/eslint-config/react"
3}

Next

1{
2  "extends": "@siriusbeck/eslint-config/next"
3}

Prettier

Default settings

Add @siriusbeck/eslint-config/prettier to your package.json file:

1{
2  "prettier": "@siriusbeck/eslint-config/prettier"
3}

Or create a prettier configuration file in the project root:

1// .prettierrc.js
2
3module.exports = require('@siriusbeck/eslint-config/prettier')

Editing the default settings

Create a prettier configuration file in the root of the project and add the code below:

1// .prettierrc.js
2
3const defaultConfig = require('@siriusbeck/eslint-config/prettier')
4
5/** @type {import('prettier').Config} */
6module.exports = {
7  ...defaultConfig
8  // Add your custom config here
9}

Custom settings

Just create a prettier configuration file at the root of the project.

What's included?

• Standard config
• TypeScript (optional)
• Prettier
• React plugin + config
• React Hooks - plugin
• JSX a11y - plugin
• Import plugin
• Import Helpers plugin
• NextJs