0.0.1 • Published 2 years ago

eslint-config-neono v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Table of Contents

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

npm install --save-dev eslint-config-neono
yarn add -D eslint-config-neono

This library has a required peerDependencies listing for eslint

Usage

Then add the extends to your .eslintrc.js:

module.exports = {
  extends: "neono",
  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:

module.exports = {
  extends: "neono/<config-name>",
};

Or in combination with the base config (recommended)

module.exports = {
  extends: ["neono", "neono/<config-name>"],
};

Config list :

  • neono
  • neono/jest
  • neono/react

Note: Due to this bug 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.

Things to know

  • The default config uses @babel/eslint-parser to support stage features that ESLint doesn't support and it opts to use the @babel/eslint-plugin 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

module.exports = {
  extends: [
    "neono/possible-errors",
    "neono/best-practices",
    "neono/es6/possible-errors",
    "neono/import",
    "neono/jest",
  ],
  rules: {
    /* custom rules */
  },
};

LICENSE

MIT