eslint-config-dortech

Configuration eslint pour les projets nodeJS

Installation & utilisation

1 - Installer les packages

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

Pour un projet TypeScript il est également recommandé d'installer le plugin TypeScript:

npm install --save-dev @typescript-eslint/eslint-plugin

Pour un projet React il est également recommandé d'installer le plugin React :

npm install --save-dev eslint-plugin-react

Pour utiliser également prettier installer :

npm install --save-dev eslint-plugin-prettier

2 - Fichier de configuration recommandé

A la racine du projet créez un fichier .eslintrc.js et coller la configuration correspondant à votre type de projet :

Projet Node + Typescript

module.exports = {
	parser: "@typescript-eslint/parser",
	extends: [
		"plugin:@typescript-eslint/recommended",
		"@dortech/eslint-config-dortech"
	],
	plugins: ["@typescript-eslint", "prettier"]
};

Projet React + Typescript

module.exports = {
	parser: "@typescript-eslint/parser",
	extends: [
		"plugin:react/recommended",
		"plugin:@typescript-eslint/recommended",
		"@dortech/eslint-config-dortech"
	],
	plugins: ["react", "@typescript-eslint", "prettier"],

	settings: {
		react: {
			version: "detect"
		}
	}
};

Configuration prettier

Pour utiliser Prettier tout d'abord installer le package suivant :

npm install --save-dev eslint-plugin-react

La configuration prettier suivante est celle communément utilisées dans nos projet :

{
	"arrowParens": "always",
	"bracketSpacing": true,
	"jsxBracketSameLine": false,
	"useTabs": true,
	"tabWidth": 2,
	"trailingComma": "none"
}

Pour l'utiliser, à la racine du projet créer un fichier .prettierrc.json et copier la configuration dedans.