@bjerk/eslint-config

bjerk/eslint-config

A reusable Eslint config built by and maintained by Bjerk.

yarn add @bjerk/eslint-config

If you want help installing the bunch of peerDependencies for this package, consider using this:

npx check-peer-dependencies

Or, if you're using pnpm, you can make it install peer dependencies automatically:

pnpm config set auto-install-peers true --location project

To make all this config work, you only need to add this to package.json:

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

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.0.0 (2023-07-13)

v5 is yet a step towards making our code more readable and maintainable!

With v5 we are introducing typed checked lining and stylistics config, as typescript-eslint recommends. To further make it easier for contributors and consumers of this eslint config, the separate topics are split into:

• @bjerk/eslint-config/base – base configuration, i.e. javascript rules
• @bjerk/eslint-config/import – import-related rules
• @bjerk/eslint-config/typescript – typescript-related rules

You can import only the ones you want if that is your style.

To make v5 work, you have to add parserOptions:

{
  "extends": "@bjerk/eslint-config",
  "parserOptions": {
    "project": true
  }
}

⚠ BREAKING CHANGES

• use typed checked linting and stylistic config (#247)
• split into separate configs (#246)

Features

• remove unused dependencies (daec2b3)
• use typed checked linting and stylistic config (#247) (b461fd6)

Code Refactoring

• split into separate configs (#246) (2968db1)