eslint-config-tyler
v0.1.7
Published
Tyler's ESLint & Prettier configuration.
Downloads
582
Readme
eslint-config-tyler
Tyler's ESLint & Prettier configuration.
It's opinionated. It works out of the box.
It supports both Node.js projects and React frontend projects.
It will detect existence of react
to enable React & frontend rules.
Installation
yarn add --dev eslint-config-tyler
Usage
Create eslint.config.mjs
:
import config from 'eslint-config-tyler/eslint.config.mjs';
export default config;
Create prettier.config.mjs
:
import config from 'eslint-config-tyler/prettier.config.mjs';
export default config;
Run:
yarn eslint . --fix
Configuration
If you need to change some configuration:
import config from 'eslint-config-tyler/prettier.config.mjs';
config.singleQuote = false;
export default config;
Ignore
ESLint
import config from 'eslint-config-tyler/eslint.config.mjs';
config[0].ignores = ['lib/', 'demo/'];
export default config;
Please note that you should NOT add any other keys to config[0]
, because according to ESLint's documentation:
if an ignores key is used without any other keys in the configuration object, then the patterns act as global ignores. Ref: https://eslint.org/docs/latest/use/configure/ignore
Prettier
You need to create a .prettierignore
file.
It cannot be configured in prettier.config.mjs
file, unfortunately.
Config rules:
config[1].rules[ruleName] = 'off' | 'warn' | 'error';
We should not change config[0]
since it is for ignore only.
Format on Save with VS Code
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
Todo
- Create a new ESLint rule, order imports, external first, local after. Blank line between external and local.
- This rule must come with auto fix feature.