Guild Eslint Config

working with this repo

At Guild, our JavaScript style is based on JavaScript Standard Style with a few exceptions:

In addition to JavaScript Standard Style, we also extend:

• plugin:@typescript-eslint/recommended
• plugin:jsx-a11y/recommended
• plugin:react/recommended
• plugin:jest/recommended
• plugin:testing-library/react
• plugin:react-hooks/recommended
• plugin:prettier/recommended

Install Config

To install the typescript config, run:

yarn add -D @guildeducationinc/eslint-config-guild-typescript

Install the peer dependencies

yarn add [email protected] @typescript-eslint/[email protected] @typescript-eslint/[email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] -D

Usage

Extend your eslint config with the installed guild config.

For typescript:

{
  "extends": "@guildeducationinc/eslint-config-guild-typescript"
}

Code Climate Usage

In your projects .codeclimate.yml config, add the appropriate config:

prepare:
  fetch:
  # For typescript
+    - url: 'https://cdn.jsdelivr.net/npm/@guildeducationinc/eslint-config-guild-typescript@{version}'
+      path: '.eslintrc.js'

plugins:
+ eslint:
+  enabled: true
+  channel: eslint-5