README.md

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 rules we apply should also be only for coding style not formatting. We should use prettier for that.

TODO

• Figure out how we can use this for javascript and typescript projects
• Add more relevant rules
• Add relevant tests

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
		},
	},
];

npx eslint

Examples

Since we work on frontend and backend and this config is still WIP we provide some examples on how to use this config in different projects.

Frontend with React

npm i globals eslint-plugin-react --save-dev

Then add this to your eslint.config.js.

import globals from "globals";
import technologiestiftung from "@technologiestiftung/eslint-config";
import react from "eslint-plugin-react";

export default [
	...technologiestiftung,
	{
		files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
		languageOptions: {
			parserOptions: {
				ecmaFeatures: {
					jsx: true,
				},
			},
			globals: {
				...globals.browser,
			},
		},
		rules: {},
		plugins: { react },
	},
];

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):

Fabian Morón Zirfas 🚇 🤔 💻 🎨

Raphael.A 👀

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

Credits

Made by

A project by

Supported by

Related Projects