@bjerk/eslint-config

@bjerk/eslint-config

A reusable Eslint config built by and maintained by Bjerk.

yarn add @bjerk/eslint-config eslint

Usage

To use this config, you'll need to add an .eslintrc.js file to your project. This file should export an object with the following structure:

module.exports = {
  extends: '@bjerk/eslint-config',
};

To make the configuration work with Typescript, you'll need to add the parserOptions as follows:

module.exports = {
  extends: '@bjerk/eslint-config',
  parserOptions: {
    project: true,
    tsconfigRootDir: __dirname,
  },
};

You can also use parts of this configuration if you want to. For example, if you only want to use our base config, you can do this:

{
  "extends": "@bjerk/eslint-config/base"
}

These are the available configs:

• @bjerk/eslint-config
• @bjerk/eslint-config/base
• @bjerk/eslint-config/import
• @bjerk/eslint-config/typescript

Note: The main @bjerk/eslint-config config includes all the others, but also prettier (and eslint-config-prettier).

Tip: We often use this along with @simenandre/prettier, a shared Prettier config. Typically, we recommend letting prettier handle all formatting, and eslint handle all linting.

Motivation

We want to have a consistent code style, and we want to promote readable and maintainable code. We also want to avoid bugs and errors, and we want to have a good developer experience.

This is our take on making that happen with Eslint!

Contributing

In comparison to many other eslint configurations, we welcome contributions to this config. If you have any ideas on how to improve it, please open an issue or a pull request!

This isn't supposed to be a Bjerk only config, but rather a config that everyone can use. We want to make it as good as possible, and we want to make it as useful as possible. If you agree with our motivation, we'd love to have you on board!

Thanks

This config is inspired by:

• runeh
• Indiv

Thanks are in order! 🙏

Changelog

5.4.0 (2023-07-24)

Features

• add ignorePatterns to base config (#260) (0f86df3)

Bug Fixes

• do not depend on prettier and typescript (#261) (824cbbd)