Skip to content

An attempt to standardize code linting and formatting across the company

Notifications You must be signed in to change notification settings

ElephantVentures/eslint-config-elephantVentures

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Why?

We have many projects with inconsistent formatting. Hopefully this will create a more uniform style
This is meant to be a collaboration for EV devs to adjust, add, and remove rules as we see fit
This will be published on NPM so to properly adjust you need to run npm version <update_type> where update_type can be: patch, major, or minor
Then run npm publish so packages that use this can know of changes

Install

This config includes the elephant ventures prettier config by default.
To install all necessary dependencies run

npm i -D eslint prettier eslint-config-prettier eslint-plugin-prettier @elephantventures/prettier-config @elephantventures/eslint-config-base

How to use?

Install then extend this configuration like so in your eslintrc

    {
        "extends": "@elephantventures/eslint-config-base"
    }

Then add this to your package.json

{
    "prettier": "@elephantventures/prettier-config"
}

Configs and Rules used

Eslint Recommended with some additional rules that can be found here

ESLint Notes

ESlint will be deprecating formatting rules November 3 blog
ESlint is also changing their configuration format in the next major release v9

Overrides

You can still override any rules in your individual project if you don't agree with one
However, keep in mind this is for code consistency so please don't go override crazy

    {
        "rules": {
            "complexity": "off"
        }
    }

About

An attempt to standardize code linting and formatting across the company

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published