@borealisgroup/eslint-config

Borealis Group - Coding Style Config

Why do we need a shared coding style accross the company?

TL;DR - For consistency, productivity and happiness.

Getting Started

Documentation Shareable Configs

• ESLint shareable config

Prerequisites

• React or Node environment
• Usage of jest as the test-suite
• env: Browser and Node environment
• parser: usage of babel (babel-eslint parser)

Note: you can still overwrite the env, globals and parser in your local .eslintrc.js.

Installing

Install the package:

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

Create a file .eslintrc.js at the root of your project:

module.exports = {
  extends: '@borealisgroup',
};

If not already done, in your editor (e.g. VSCode), enable:

• ESLint: Run the linter on type
• ESLint: Auto Fix on save
• Editor: Format on save (using Prettier)
• Prettier: ESLint Integration

ESLint

Plugins

• airbnb: one of the most widely used code styles for ECMAScript 6+ and React.

Rules

Next Plugins to evaluate

The following plugins need to be tested before being added. From awesome-eslint:

• Node - Linting rules for Node.js (checking importing paths, ES syntax, ...).
• GraphQL - Check your GraphQL query strings against a schema.
• SQL - SQL linting rules for ESLint.
• HTML - Linting for JavaScript inside of HTML script tags.
• JSON - Lint your JSON files.

Prettier

This ESLint configuration can work together with prettier, thanks to eslint-plugin-prettier

Contributing

If you want to modify plugins or rules in your project, please submit a pull request instead of overwriting your local config.

For each addition, add a justification in this README.

Authors

Borealis Digital Studio