@clearleft/eslint-config-clearleft

ESLint configuration to be shared across all Clearleft repositories

Usage no npm install needed!

<script type="module">
  import clearleftEslintConfigClearleft from 'https://cdn.skypack.dev/@clearleft/eslint-config-clearleft';
</script>

README

eslint-config-clearleft

ESLint configuration to be shared across all Fractal repositories.

NPM Version

Overview

This package is an ESLint shareable config which can be used in conjunction with an ESLint based plugin such as xo, in order to help maintain consistent styles across a codebase.

"xo": {
  "extends": "@clearleft/eslint-config-clearleft"
}

Installation

Installation is via npm.

npm i @clearleft/eslint-config-clearleft

Usage

To use with xo, first ensure the package has been installed (see above) and then pass the package name to the the extends option in package.json:

{
  "name": "repo-name",
  ...
  },
  "devDependencies": {
    "@clearleft/eslint-config-clearleft": "0.1.0"
  },
  "xo": {
    "extends": "@clearleft/eslint-config-clearleft"
  }
}

Requirements

Node: >= 6.0.0