Skip to content

axellero-io/eslint

Repository files navigation

ESLint configurations and code-style guidelines

axellero/eslint repository github workflow status axellero/eslint repository license

Installation

All packages have their respective peerDependencies and as long as you add everything required by the package, you are good to go.

Packages themselfs are divided by their plugin usage and made independent but at the same time integrated by keeping in mind that they can be used in conjunction with one another.

Here is just a default script section for some who tend to skip these description parts:

$ yarn add --save-dev @axellero/eslint-config

Usage

All you have to do is to extend the config you want, and we'll take it from there:

{
  // package.json
  "eslintConfig": {
    "extends": [
      // Either extend ALL configurations at once...
      "@axellero",
      // ...or piece by piece
      "@axellero/eslint-config-core",
      "@axellero/eslint-config-typescript",
      "@axellero/eslint-config-prettier",
    ]
  }
}

Configurations

All configurations were made and tested with care. We tried to match our needs, but maybe you could find them useful as well.

axellero eslint config npm package version Collection of all @axellero/eslint-config-* packages
axellero eslint config core npm package version ESLint configuration core rules
axellero eslint config prettier npm package version ESLint configuration for Prettier
axellero eslint config import npm package version ESLint configuration for ES6 Imports and Exports
axellero eslint config typescript npm package version ESLint configuration for TypeScript
axellero eslint config react npm package version ESLint configuration for React/ReactHooks
axellero eslint config jsx a11y npm package version ESLint configuration for JSX Accessibility
axellero eslint config functional npm package version ESLint configuration for Functional Programming
axellero eslint config jest npm package version ESLint configuration for Jest testing library

Contributing

Any PR is welcomed by our @js-opensource team. Check out our contributing guidelines for more info.

License

axellero eslint config license