eslint-config-frontful is packaged provider of ESLint config. It is default linter setup for Frontful infrastructure.

Installation

# Using yarn
yarn add eslint-config-frontful
# or npm
npm install -s eslint-config-frontful

Integration

Instructions for editor and IDE

Add .eslintrc file to root of the project and extend ESLint config with eslint-config-frontful (eslint-config prefix should be omitted). Additional flags can be added to .eslintrc, this will only affect editor and IDE instrumentation

// .eslintrc
{
  "extends": "frontful"
}

Configuration

eslint-config-frontful can be configured with one of two configuration properties

• options - options that will be passed to eslint-config-frontful/provider that generates ESLint configuration
• config - fully formed ESLint configuration that can be created manually or using eslint-config-frontful/provider

Configuration can be done in several ways as provided by frontful-config, bellow are two examples

• Add frontful.eslint.options object to package.json. Keep in mind that these options are not ESLint options but ones accepted by eslint-config-frontful/provider

// package.json
{
  "frontful": {
    "eslint": {
      "options": {
        ...
      }
    }
  }
}

• Create ES5 config.eslint.js file, and reference this file in frontful.eslint in package.json

// config.eslint.js
const provider = require('eslint-config-frontful/provider')
module.exports = {
  config: provider({
    ...
  })
}

// package.json
{
  "frontful": {
    "eslint": "./config.eslint.js"
  }
}