ESLint configuration for Functional Programming
\n\n\n\n## Installation\nAdd peer dependencies:\n```shell\n$ yarn add -D eslint eslint-plugin-functional\n```\n...then install config packages:\n```shell\n$ yarn add -D @axellero/eslint-config-functional\n```\n\n## Usage\n```json5\n{\n // package.json\n \"eslintConfig\": {\n \"extends\": [\n \"@axellero/eslint-config-functional\",\n // Read more about strict config below...\n \"@axellero/eslint-config-functional/strict\",\n // WARNING.\n // Requires tsconfig to be presented in `parserOptions.project`.\n // May cause performance problems, so we don't recommend adding it right away.\n \"@axellero/eslint-config-functional/with-type-check\"\n ]\n }\n}\n```\n\n## Strict Config\nBy default, javascript doesn't provide enough utilities to fully support functional programming code.\nBecause of that by default we will deliver general good practice rules.\nBut if you're using fp libraries (like [fp-ts](https://github.com/gcanti/fp-ts)\nor [purify](https://github.com/gigobyte/purify)) we recommend adding the Strict Config.\n\n## Contributing\nAny PR is welcomed by our **@js-opensource** team.\nCheck out our [contributing](../../CONTRIBUTING.md) guidelines for more info.\n\n## License\n[](../../LICENSE)\n","readmeFilename":"README.md"}