@promo-com/eslint-config

ESLint shareable config for the Promo.com JS style guide

Usage no npm install needed!

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

README

Promo.com eslint config

ESLint shareable config for the Promo.com JS style guide

Style

We started this styleguide extending airbnb's style, invested time reading through all rules, discussing and changing some, most of the time to be less strict. We hope you'll find this useful.

Setup

ESlint and its plugins must run from your projects dependencies, so install by running this (on npm 5+):

$ npx install-peerdeps --dev @promo-com/eslint-config

In your .eslintrc.js file, make sure to extend this package:

extends: [
  '@promo-com',
]

Obviously, you may still want to override rules, add globals etc. to exactly fit your style and needs.