Skip to content

rellafella/eslint-config

Repository files navigation

@rellafella/eslint-config

Features

Installation

Install the package with

npm i -D @rellafella/eslint-config

Then install the peerDependency packages.

npm i -D eslint@^7.16.0 prettier@^2.1.2 stylelint@^13.8.0

The correct versions of each peerDependency package are listed by the command:

npm info "@rellafella/eslint-config@latest" peerDependencies

Or, if using npm 5+, use this shortcut:

npx install-peerdeps --dev @rellafella/eslint-config

Usage

This package will create the following 3 initial config files during installation:

  • eslint.config.js
  • prettier.config.js
  • stylelint.config.js

If the config file exists already, it won't create/replace the file.

If you want to config manually, please add the config to either your package.json:

{
  "eslintConfig": {
    "extends": "@rellafella"
  }
}

to your .eslintrc:

{
  "extends": "@rellafella"
}

or .eslintrc.js:

module.exports = {
  extends: "@rellafella",
};

Prettier Config

This is how you use or extend the @rellafella/eslint-config prettier config in your app:

// prettier.config.js
module.exports = require("@rellafella/eslint-config/prettier.config");

Assumptions

This ESLint configuration comes with some fundamental assumptions:

  • node environment
  • browser and/or node environment
  • parser: babel (used babel-eslint parser)

Even though I made some assumptions, you can easily overwrite, extend and unset rules and any other setting in your custom eslint config.

About

Personal eslint config

Resources

Stars

Watchers

Forks

Packages

No packages published