@looker/eslint-config

@looker/eslint-config

looker-open-source Typescript / Javascript Configuration

This repository provides shared configuration for tooling used in Typescript/Javascript projects in development as part of the looker-open-source organization

It provides configurations for:

• ESLint (Javascript & Typescript linter)
• Stylelint (CSS linter)
• Prettier (Javascript & Typescript code-formatter)
• Typescript

We've included support for React & Styled Components in our configurations as they're very commonly used in Looker Typescript projects.

Installation

The default export contains all default Airbnb ESLint rules, including ECMAScript 6+, and the ones listed below. It requires some peerDependencies as well.

Install the package with

yarn add @looker/eslint-config eslint -D

Usage

ESLint

Add the config to either your package.json:

{
  "eslintConfig": {
    "extends": "@looker/eslint-config"
  }
}

to your eslint.config.js (or .eslintrc.js):

module.exports = {
  extends: '@looker/eslint-config',
}

NOTE: Adding an eslint.config.js file will allow you to add your own rules to so that your package can add (or disable) additional lint rules as needed:

module.exports = {
  extends: ['@looker/eslint-config/workspaces'],
  rules: {
    /* @TODO - To level-up our code quality we shouldn't ever use `any` */
    '@typescript-eslint/no-explicit-any': 'off',
  },
}

Yarn Workspaces Support

Need to support a project leveraging Yarn Workspaces? Use: @looker/eslint-config/workspaces

Typescript (TSConfig)

We provide a few stock tsconfig setups for convenience as well. It's expected that you'll need to add more configuration beyond the basics offered within these defaults.

In your project's tsconfig.json file:

{
  "extends": "@looker/eslint-config/tsconfig",
  "compilerOptions": { ... }
}

An extension with a few React-specific options is also available: @looker/eslint-config/tsconfig.react.

NOTE: The React-specific configuration is designed for projects using Babel's Typescript support to build and therefore is only appropriate for doing type-lint work, not for actually building javascript artifacts.

Prettier

See Prettier-specific README

StyleLint

Add the config to your package.json:

{
  "stylelint": {
    "extends": "@looker/eslint-config/stylelint"
  }
}

Alternatively, you can use a standalone stylelint.config.js file:

module.exports = {
  extends: ['@looker/eslint-config/stylelint'],
}

LICENCE

MIT