README
@acmecryptocorp/eslint-config
Description
Acme Crypto Corp's extensible config for ESlint.
Installation
Install the config
npm install -D @acmecryptocorp/eslint-config
yarn add --dev @acmecryptocorp/eslint-config
and peer dependencies:
npx install-peerdeps --dev @acmecryptocorp/eslint-config
or manually:
npm:
npm install -D \
@acmecryptocorp/eslint-plugin@~1.1.1 \
@typescript-eslint/eslint-plugin@~2.17.0 \
eslint@^6.8.0 \
eslint-config-airbnb@~14.0.0 \
eslint-config-prettier@~6.9.0 \
eslint-import-resolver-ts@~0.4.2 \
eslint-plugin-eslint-comments@~3.1.1 \
eslint-plugin-filenames@~1.3.2 \
eslint-plugin-flowtype@~4.6.0 \
eslint-plugin-import@2.18.2 \
eslint-plugin-no-loops@~0.3.0 \
eslint-plugin-optimize-regex@~1.1.7 \
eslint-plugin-promise@~4.1.1 \
eslint-plugin-sort-class-members@~1.6.0 \
eslint-plugin-unicorn@~15.0.1 \
typescript@^3.6.3
yarn:
yarn add --dev \
@acmecryptocorp/eslint-plugin@~1.1.1 \
@typescript-eslint/eslint-plugin@~2.17.0 \
eslint@^6.8.0 \
eslint-config-airbnb@~14.0.0 \
eslint-config-prettier@~6.9.0 \
eslint-import-resolver-ts@~0.4.2 \
eslint-plugin-eslint-comments@~3.1.1 \
eslint-plugin-filenames@~1.3.2 \
eslint-plugin-flowtype@~4.6.0 \
eslint-plugin-import@2.18.2 \
eslint-plugin-no-loops@~0.3.0 \
eslint-plugin-optimize-regex@~1.1.7 \
eslint-plugin-promise@~4.1.1 \
eslint-plugin-sort-class-members@~1.6.0 \
eslint-plugin-unicorn@~15.0.1 \
typescript@^3.6.3
Usage
Add desired configuration to your .eslintrc
:
Example:
.eslintrc.json
"extends": [
"@acmecryptocorp",
"@acmecryptocorp/eslint-config/flow"
]
.eslintrc.yml
extends:
- '@acmecryptocorp'
- '@acmecryptocorp/eslint-config/flow'
Notes
This config is recommended to be used alongside Prettier.
See: @acmecryptocorp/prettier-config
Configurations
@acmecryptocorp
General configuration.
Configuration files: json
, yaml
.
@acmecryptocorp/eslint-config/flow
Flow related configuration.
Configuration files: json
, yaml
.
@acmecryptocorp/eslint-config/typescript
Configuration for Typescript
Important: You must specify path to your typescript configuration file in parser options in your .eslintrc
.
Example:
parserOptions:
project: 'tsconfig.json'
Configuration files: json
, yaml
.
@acmecryptocorp/eslint-config/typescript-beta
DEPRECTATED
Beta configuration for Typescript
Configuration files: json
, yaml
.
Links
- @acmecryptocorp/eslint-plugin
- @typescript-eslint/eslint-plugin
- eslint-config-airbnb-base
- eslint-config-prettier
- eslint-plugin-eslint-comments
- eslint-plugin-filenames
- eslint-plugin-flowtype
- eslint-plugin-import
- eslint-plugin-no-loops
- eslint-plugin-optimize-regex
- eslint-plugin-promise
- eslint-plugin-sort-class-members
- eslint-plugin-unicorn