Eslint-config-ruppy-base NPM

`eslint-config-ruppy-base` 🐣

Ruppy's base eslint configurations

Description

This eslint configurations is mostly follow and heavily inspired by Airbnb JavaScript Style Guide. Ruppy use prettier styles for formatting the codes. With that it mind, this configs extends prettier for linting javascript code styles with prettier. This eslint configurations has two exported configs.

`ruppy-base`

This is the default configs. It contains all eslint rules without deprecated and removed rules. It support for linting ES2015/ES6 - ES2017 javascript syntax without ESModules by default.

`ruppy-base/legacy`

This configs support for linting legacy javascript language (ES5 and below).

Usage

The easiest way to add this configs into project is running this commands in your root project:
```
npx eslint-ruppy -i
```

OR follow along these steps below:

Install this configs and its peer dependencies.

yarn add -D eslint-config-ruppy-base eslint prettier

npm install -D eslint-config-ruppy-base eslint prettier

Create .eslintrc.js file in the root project and extends this configs. Also set the environment your project would live on.
```
require("eslint-config-ruppy-base/patch");

module.exports = {
  extends: ["ruppy-base"], // or 'ruppy-base/legacy' for ES5 and below
  env: {
    node: true,
    browser: true,
  },
};
```
An environment defines global variables that are predefined. See eslint configurations guide for available environments.
Optionally create prettier configuration file for the code styles, .prettierrc:
```
{
  "overrides": [
    {
      "files": "*.{js,jsx,ts,tsx}",
      "options": {
        "singleQuote": true
      }
    }
  ]
}
```
See all available prettier options and how to write configuration files to see more info on that.