https://github.com/natura-cosmeticos/eslint-config-natura

Eslint rules to achieve better code, using Airbnb styles rules
https://github.com/natura-cosmeticos/eslint-config-natura

eslint eslint-plugin nodejs styleguide

Last synced: about 5 hours ago
JSON representation

Eslint rules to achieve better code, using Airbnb styles rules

• Host: GitHub
• URL: https://github.com/natura-cosmeticos/eslint-config-natura
• Owner: natura-cosmeticos
• License: mit
• Created: 2018-10-25T19:09:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-09T10:18:26.000Z (6 months ago)
• Last Synced: 2024-11-15T04:08:02.035Z (4 days ago)
• Topics: eslint, eslint-plugin, nodejs, styleguide
• Language: JavaScript
• Size: 193 KB
• Stars: 4
• Watchers: 12
• Forks: 2
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/693bdf5edeec45c6b410be4e7418eda8)](https://www.codacy.com/app/handrus_1938/eslint-config-natura?utm_source=github.com&utm_medium=referral&utm_content=natura-cosmeticos/eslint-config-natura&utm_campaign=Badge_Grade)

[![Build Status](https://travis-ci.org/natura-cosmeticos/eslint-config-natura.svg?branch=master)](https://travis-ci.org/natura-cosmeticos/eslint-config-natura)

[![Known Vulnerabilities](https://snyk.io/test/github/natura-cosmeticos/eslint-config-natura/badge.svg?targetFile=package.json)](https://snyk.io/test/github/natura-cosmeticos/eslint-config-natura?targetFile=package.json)

# Natura ESLint Configuration

## What for

[ESLint](https://eslint.org/) rules to achieve better code, using Airbnb styles rules.

The Natura ESLint configuration extends the

[Airbnb](https://github.com/airbnb/javascript) configuration. While Airbnb

provides a decent style configuration it does not use all the available rules to

help enhance code quality like the following ones among others:

- [max-depth](https://eslint.org/docs/rules/max-depth)

- [max-lines-per-function](https://eslint.org/docs/rules/max-lines-per-function)

- [complexity](https://eslint.org/docs/rules/complexity)

### Why a new eslint-config?

This project helps achieve the `good maintainability` need, offering a default lint for all Node.js projects.

## How to use

To use this configuration install the package on your project using either npm or yarn:

```bash

npm i --save-dev '@naturacosmeticos/eslint-config-natura'

yarn add -D '@naturacosmeticos/eslint-config-natura'

```

We recommend you to install accepting only new patch releases (ex: `~2.0.0`), once new minor releases could add new rules that can broke your pipeline.

Add `@naturacosmeticos/natura` to the eslint `extends` option in the `.eslintrc` file:

```

{

  "env": {

    "es6": true,

    "mocha": true,

    "node": true

  },

  "extends": ["@naturacosmeticos/natura"],

  "parserOptions": {

    "ecmaVersion": 2017

  },

  "settings": {

    "import/resolver": {

      "node": {

        "paths": ["src", "test"]

      }

    }

  }

}

```

Airbnb-base is already included, no need to add it.

## How to contribute

You can contribute submitting [pull requests](https://github.com/natura-cosmeticos/eslint-config-natura/pulls).

### Setup

Run `yarn` or if your use npm `npm i`.