README.ru.md

@funboxteam/eslint-config

Пакет с правилами для линтера ESLint, соответствующие принятому в компании стайлгайду.

Основан на конфиге от Airbnb.

Установка

npm install --save-dev @funboxteam/eslint-config

Использование

Подключить в конфиг рабочего проекта, используя ключ -c, и передать пути для поиска файлов в качестве аргументов:

eslint -c node_modules/@funboxteam/eslint-config/.eslintrc.js src/app src/sandbox

Для линтинга тестов следует использовать отдельный конфиг:

eslint -c node_modules/@funboxteam/eslint-config/.eslintrc.test.only.js src/tests

Также можно создать свой файл .eslintrc.js, и доопределить в нём этот конфиг. Пример такого доопределения:

module.exports = {
  extends: '@funboxteam',
  env: {
    browser: true
  },
  globals: {
    fetcher: 'readonly',
    System: 'readonly',
    moment: 'readonly'
  },
  settings: {
    'import/resolver': {
      webpack: {
        config: 'config/webpack.config.dev.js',
      }
    }
  },
}

Пример доопределения конфига для тестов:

module.exports = {
  extends: '@funboxteam/eslint-config/tests',
  globals: {
    __utils__: 'readonly',
  }
}

Более подробно о том, как устроен файл .eslintrc.js, и что в нём можно настраивать, можно прочитать в документации ESLint.