@technologiestiftung/eslint-config

Sharable eslint config for @technologiestiftung

This is a sharable eslint config for the @technologiestiftung organization. Should be the basis for JS and TS. Still WIP

The idea here is to start out with a flat config but still be backwards compatible with the old config. So our team does not have to set the env variable ESLINT_USE_FLAT_CONFIG=true but can just reference this config as extend in the old config style if they need to. After some testing it is not that easy to turn the config from flat file to commonjs. Since the old config will be deprecated soon with the release of eslint 9.0 this is actually to much effort. So we will just use the flat config and be done with it. \o/

The rules we apply should also be only for coding style not formatting. We should use prettier for that.

TODO

• Add more relevant rules
• Figure out how we can use this for javascript and typescript projects
• Add tests
• Figure out how we can leverage the flat config already and be backwards compatible

Prerequisites

• Node.js
• eslint

Installation

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

Usage

In your eslint.config.js file, add the following:

import technologiestiftung from "@technologiestiftung/eslint-config";

export default [
  ...technologiestiftung,
	rules: {
    // your rules here
	}
]

ESLINT_USE_FLAT_CONFIG=true npx eslint

If you are using VSCode set the following in your settings:

{ "eslint.experimental.useFlatConfig": true }

Development

• Add good rules to index.js

Tests

npm t

Contributing

Before you create a pull request, write an issue so we can discuss your changes.

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Credits

Made by

A project by

Supported by

Related Projects