# eslint-config-ruppy-base

> Ruppy's base eslint configurations 🐣

Latest version **3.0.0** (published 2021-09-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install eslint-config-ruppy-base
pnpm add eslint-config-ruppy-base
yarn add eslint-config-ruppy-base
bun add eslint-config-ruppy-base
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2021-09-12 |
| First published | 2020-05-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 43.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ruppy.io |
| Maintainers | latipun7 |
| Keywords | eslint, ruppy, config, eslintconfig, eslint-config, prettier, prettierconfig, prettier-config |

## Links

- npm: https://www.npmjs.com/package/eslint-config-ruppy-base
- Repository: https://github.com/Ruppyio/eslint-configs
- Homepage: https://github.com/Ruppyio/eslint-configs/tree/main/packages/eslint-config-ruppy-base#readme
- Issues: https://github.com/Ruppyio/eslint-configs/issues
- npm.io page: https://npm.io/package/eslint-config-ruppy-base

## Dependencies (4)

- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.3.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^4.0.0
- [@rushstack/eslint-patch](https://npm.io/package/@rushstack/eslint-patch.md) ^1.0.6
- [confusing-browser-globals](https://npm.io/package/confusing-browser-globals.md) ^1.0.10

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2021-09-12
- 2.0.1 — 2021-08-07
- 2.0.0 — 2021-08-05
- 1.6.1 — 2021-06-02
- 1.6.0 — 2021-03-08
- 1.5.0 — 2020-11-02
- 1.4.0 — 2020-09-26
- 1.3.0 — 2020-09-07
- 1.2.0 — 2020-08-29
- 1.1.4 — 2020-08-01
- 1.1.3 — 2020-08-01
- 1.1.2 — 2020-07-25
- 1.1.1 — 2020-07-20
- 1.0.0 — 2020-06-29
- 0.6.0 — 2020-06-20
- … 7 more at https://npm.io/package/eslint-config-ruppy-base/versions

## README

# `eslint-config-ruppy-base` 🐣

[![Discord][discord-image]][discord-url]
[![GitHub Workflow Status][workflow-image]][workflow-url]
[![NPM Package][npm-image]][npm-url]

> Ruppy's base eslint configurations

## Description

This eslint configurations is mostly follow and heavily inspired by
[Airbnb JavaScript Style Guide][airbnb]. Ruppy use [prettier][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][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:

  ```bin
  npx eslint-ruppy -i
  ```

---

**OR** follow along these steps below:

- Install this configs and its peer dependencies.

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

  or

  ```bin
  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.

  ```js
  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][eslint-env] for available environments.

- Optionally create prettier configuration file for the code styles, `.prettierrc`:

  ```json
  {
    "overrides": [
      {
        "files": "*.{js,jsx,ts,tsx}",
        "options": {
          "singleQuote": true
        }
      }
    ]
  }
  ```

  See all available [prettier options][prettier-option] and
  [how to write configuration files][prettier-config] to see more info on that.

## Hacking to the Gate~! 🎶

<!-- Variables -->

[discord-image]: https://img.shields.io/discord/758271814153011201?label=Developers%20Indonesia&logo=discord&style=flat-square
[discord-url]: https://discord.gg/njSj2Nq "Chat and discuss at Developers Indonesia"
[workflow-image]: https://img.shields.io/github/workflow/status/Ruppyio/eslint-configs/Continuous%20Integration%20and%20Continuous%20Delivery%20%E2%9A%99%F0%9F%9A%80?label=CI%2FCD&logo=github%20actions&style=flat-square
[workflow-url]: https://github.com/Ruppyio/eslint-configs/actions "GitHub Actions"
[npm-image]: https://img.shields.io/npm/v/eslint-config-ruppy-base?label=package&logo=npm&style=flat-square
[npm-url]: https://npmjs.org/package/eslint-config-ruppy-base "eslint-config-ruppy-base on NPM"
[airbnb]: https://github.com/airbnb/javascript "Airbnb JavaScript Style Guide"
[eslint-rules]: https://eslint.org/docs/rules/ "ESLint Rules"
[eslint-env]: https://eslint.org/docs/user-guide/configuring#specifying-environments "ESLint Environments"
[prettier]: https://prettier.io/ "Prettier Code Formatter"
[prettier-option]: https://prettier.io/docs/en/options.html "Prettier Options"
[prettier-config]: https://prettier.io/docs/en/configuration.html "Prettier Configurations"

---
_Source: https://npm.io/package/eslint-config-ruppy-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._