A set of ESLint shareable configs for TypeScript projects.
- Out of the box support for TypeScript, React, and Markdown
- Sort your imports
- Sort your fields in
package.json - Prefer top-level function declarations over function expressions
$ npm install -D eslint prettier @ocavue/eslint-config
You will need to use the new "flat" ESLint configuration (i.e. eslint.config.js).
In your eslint.config.js file, add the following to extend the basic config:
// eslint.config.js
import { basic } from '@ocavue/eslint-config'
export default [...basic()]If you want to use the React config, you can do the following:
// eslint.config.js
import { basic, react } from '@ocavue/eslint-config'
export default [...basic(), ...react()]If you want to use the check the code blocks in markdown files, you can do the following:
// eslint.config.js
import { basic, markdown } from '@ocavue/eslint-config'
export default [...basic(), ...markdown()]{
"scripts": {
"lint": "eslint .",
"check": "prettier --check .",
"fix": "eslint --fix . && prettier --write ."
}
}Add a .prettierignore file in the root of your project. You can copy the .prettierignore file from this project.
If you are using VS Code, you and install ESLint extension and Prettier extension, then add the following to your VS Code settings:
// .vscode/settings.json
{
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}