@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

# or
npm install @looker/eslint-config --save-dev

Then install the correct versions of each peerDependency package, which are listed by the command:

yarn add @looker/eslint-config -D --peer

# or
npx install-peerdeps --dev @looker/eslint-config

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

Prettier

See Prettier-specific README

StyleLint

Now add the config to either your package.json:

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

to your stylelint.config.js:

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

LICENCE

MIT