eslint-config-sigfox

eslint-config-sigfox

This is the shared Eslint configuration used for javascript projects at Sigfox.

It is meant to be used with Prettier (all rules handled by Prettier are turned off).

⚠️ Work in progress

This package is still at its early stages, and radical changes may occur.

Installation

Yarn

If you use yarn, run npm info "eslint-config-sigfox@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency.

npm 5+

npx install-peerdeps --dev eslint-config-sigfox

Usage

Here is our typical .eslintrc file:

// .eslintrc
{
  "extends": "eslint-config-sigfox",
  "parser": "babel-eslint",
  "env": {
    "browser": true,
    "node": true,
    "es6": true
  },
  "rules": {}
}

We use the babel-eslint. It's not mandatory, but if you are using babel (including babel-loader in your webpack or other flavors), you should use this parser to avoid false positives.

Meant to be used with Prettier

All rules that are unnecessary or might conflict with Prettier are turned off.

This is the Prettier config we use:

// .prettierrc

{
  "printWidth": 80,
  "tabWidth": 2,
  "tabs": false,
  "semi": true,
  "singleQuote": true,
  "trailingComma": "none",
  "bracketSpacing": true,
  "jsxBracketSameLine": false,
  "arrowParens": "avoid",
  "proseWrap": "preserve"
}

Please refer to the Prettier documentation to integrate it in your environment and editor/IDE. Don't forget to consider prettier-eslint.

Troubeshooting

If you are migrating from a previous eslint version or configuration, or just did an upgrade of this package or dependencies, follow these steps after installation and configuration:

• destroy your node_modules directory
• if you are using yarn, clean its cache: yarn cache clean
• yarn or npm install
• reboot your editor / IDE

Contributing

Don't hesitate to open issues, submit pull requests, and to start a debate.

Still, you have to keep in mind that this is the configuration we use at Sigfox, and that we might decline change requests because they don't comply with our internal choices, and not because they are stupid.

Feel free to fork, change, rename and pubish your own package based on this one.

Licence and credits

MIT

Big thanks to Airbnb for publishing their eslint config packages, which we used and tuned for a time before deciding to make our own package. Most of the code here is still simple copy/paste of it.