Installation

Add peer dependencies:

$ yarn add -D eslint eslint-plugin-functional

...then install config packages:

$ yarn add -D @axellero/eslint-config-functional

Usage

{
  // package.json
  "eslintConfig": {
    "extends": [
      "@axellero/eslint-config-functional",
      // Read more about strict config below...
      "@axellero/eslint-config-functional/strict",
      // WARNING.
      // Requires tsconfig to be presented in `parserOptions.project`.
      // May cause performance problems, so we don't recommend adding it right away.
      "@axellero/eslint-config-functional/with-type-check"
    ]
  }
}

Strict Config

By default, javascript doesn't provide enough utilities to fully support functional programming code. Because of that by default we will deliver general good practice rules. But if you're using fp libraries (like fp-ts or purify) we recommend adding the Strict Config.

Contributing

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

License