@assemble-inc/eslint-config-assemble

Assemble Inc ESLint Configuration

This package contains Assemble Inc's ESLint configurations for both Typescript and JavaScript projects. ESLint is used for enforcement of code quality across Assemble Inc projects.

All ESLint rules enforcing code style have been disabled in favor of using prettier for code formatting. Refer to the prettier-config for integrating prettier into your application.

Installation

From the root of your package, install the Assemble Inc. configuration:

yarn add --dev eslint-config-assemble

You will also need to install the following peer dependencies:

yarn add --dev eslint prettier eslint-plugin-prettier

Configuration

Add Linting Scripts

Add the following scripts to your package.json.

"scripts": {
  "lint": "eslint \"src/**/*.{jsx,js,ts,tsx}\"",
  "lint:fix": "eslint \"src/**/*.{jsx,js,ts,tsx}\" --fix"
}

The lint:fix script will automatically attempt to fix reported errors. Leaving this off will report errors/warnings without attempting to fix them.

You can update the file extensions list to suit the particular files you would like to lint.

Import the Linting configuration

The Assemble Inc. configuration needs to be imported into ESLint. Add the following to your package.json.

  "eslintConfig": {
    "extends": [
      "eslint-config-assemble"
    ],
    "env": {
      "browser": true,
      "node": true
    }
  }

Usage

To lint all typescript files in your project, run yarn lint.

To automatically fix linting errors in your project, run yarn lint:fix or yarn lint --fix.