Giter Club home page Giter Club logo

eslint-config-nathanvale's Introduction

eslint-config-nathanvale

travis build version downloads MIT License semantic-release

ESLint rules for all of my personal projects. Feel free to use these conventions :-)

Usage

Install the conventions by running:

npm install --save-dev eslint eslint-config

Then add the extends to your .eslintrc:

{
  "extends": "eslint-config",
  "rules": {
    // your overrides
  }
}

Other configs

This config also exposes a few other configs that I use often and pull in as needed.

You can use them standalone:

{
  "extends": "eslint-config/<config-name>"
}

Or in combination with the base config (recommended)

{
  "extends": ["eslint-config", "eslint-config/<config-name>"]
}

Note: I'm not certain why, but sometimes you need to have the associated plugins installed to make things work. I recommend adding them as dependencies to your project if you're going to use the config for it.

  • babel-module: babel-plugin-module-resolver for the import plugin to work with the module-resolver babel plugin (eslint-plugin-import and eslint-import-resolver-babel-module)
  • babel-react-require: babel-plugin-react-require for when you're using the react-require babel plugin (should be used with "eslint-config/react" as well) (eslint-plugin-react)
  • jest: jest testing framework
  • jsx-a11y: eslint-plugin-jsx-a11y for rules regarding accessibility with JSX (eslint-plugin-jsx-a11y)
  • react: React JS library (eslint-plugin-react)
  • webpack: Webpack for the import plugin to work with webpack overloaded imports/requires (eslint-plugin-import and eslint-import-resolver-webpack)

Things to know

  • The default config uses babel-eslint to support stage features that ESLint doesn't support and it opts to use the eslint-plugin-babel rules over the ESLint rules to support rules for these features as well.
  • All plugins needed for rules used by these configs are dependencies of this module so you don't have to install anything on your own.
  • The default config actually is composed of several configurations and you can use those individually. These are the configs it's using: possible-errors.js, best-practices.js, stylistic.js, es6/index.js, and import/index.js. You can use each of these configs yourself if you want to leave my own personal style out of it. Also, the es6 and import configs each have a possible-errors.js, best-practices.js, and stylistic.js which they are composed of as well.

Example of highly customized config

{
  "extends": [
    "eslint-config/possible-errors", "eslint-config/best-practices",
    "eslint-config/es6/possible-errors", "eslint-config/import",
    "eslint-config/jest"
  ],
  "rules": { /* custom rules */ }
}

LICENSE

MIT

eslint-config-nathanvale's People

Contributors

alexandernanberg avatar barrythepenguin avatar greenkeeperio-bot avatar huchenme avatar mohamed3on avatar nathanvale avatar ultrox avatar weyert avatar zack9433 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.