Skip to content

brainylab/eslint-config

Repository files navigation

BrainyLab eslint-config

this is the base configuration of ESLint is used in the Projects made by BrainyLab Development.

Install Config

# npm
npm i --save-dev eslint prettier @brainylab/eslint-config

#yarn
yarn add -D eslint prettier @brainylab/eslint-config

#pnpm
pnpm add -D eslint prettier @brainylab/eslint-config

Usage Flat Config - ESlint 9+

Require Node.js >= 18.18, and ESLint >= 8.56.0. create file eslint.config.js or EMS eslint.config.mjs in main project folder, add the lines below in the file.

import { createConfig } from '@brainylab/eslint-config';
export default createConfig({
	configs: [
		/* your custom config */
	],
	presets: {
		node: true,
		typescript: true,
		react: true,
		next: true,
	},
});

Presets

import { presets } from '@brainylab/eslint-config/configs';
export default [
	[
		/* your custom config */
	],
	// using base config
	...presets.base,
	// using typescript config
	...presets.typescript,
	// using typescript config
	...presets.node,
	// using react config
	...presets.react,
	// using react config
	...presets.next,
];

Config Prettier

This library focuses on linter and prettier was separated for better performance, to use prettier together with ESlint, following this documentation BrainyLab Prettier Config

Config VS Code to auto fix

Install ESlint Plugin on VSCode:

create ou alter .vscode/settings.json.

{
	"editor.codeActionsOnSave": {
		"source.fixAll.eslint": "explicit"
	},

	// eslint >= 8.56.0 and < 9 add line on VSCode
	"eslint.experimental.useFlatConfig": true
}

License

MIT