Reasonable ESLint configs for epic web devs
npm install @epic-web/config
This makes assumptions about the way you prefer to develop software and gives you configurations that will actually help you in your development.
``
npm install @epic-web/config
[![Build Status][build-badge]][build]
[![MIT License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]
You're a professional, but you're mature enough to know that even professionals
can make mistakes, and you value your time enough to not want to waste time
configuring code quality tools or babysitting them.
This is a set of configurations you can use in your web projects to avoid
wasting time.
You can learn about the different decisions made for this project in
the decision docs.
Technically you configure everything yourself, but you can use the configs in
this project as a starter for your projects (and in some cases you don't need to
configure anything more than the defaults).
The easiest way to use this config is in your package.json:
`json`
"prettier": "@epic-web/config/prettier"
Customizing Prettier
If you want to customize things, you should probably just copy/paste the
built-in config. But if you really want, you can override it using regular
JavaScript stuff.
Create a .prettierrc.js file in your project root with the following content:
`js
import defaultConfig from '@epic-web/config/prettier'
/* @type {import("prettier").Options} /
export default {
...defaultConfig,
// .. your overrides here...
}
`
Create a tsconfig.json file in your project root with the following content:
`json`
{
"extends": ["@epic-web/config/typescript"],
"include": ["/.ts", "/.tsx", "/.js", "/.jsx"],
"compilerOptions": {
"paths": {
"#app/": ["./app/"],
"#tests/": ["./tests/"]
}
}
}
Create a reset.d.ts file in your project with these contents:
`typescript`
import '@epic-web/config/reset.d.ts'
Customizing TypeScript
Learn more from
the TypeScript docs here.
Create a eslint.config.js file in your project root with the following
content:
`js
import { config as defaultConfig } from '@epic-web/config/eslint'
/* @type {import("eslint").Linter.Config[]} /
export default [...defaultConfig]
`
Customizing ESLint
Learn more from
the Eslint docs here.
There are endless rules we could enable. However, we want to keep our
configurations minimal and only enable rules that catch real problems (the kind
that are likely to happen). This keeps our linting faster and reduces the number
of false positives.
Create a .oxlintrc.json file in your project root with the following content:
`json`
{
"extends": ["./node_modules/@epic-web/config/oxlint-config.json"]
}
Note: typescript/no-misused-promises and typescript/no-floating-promises are
type-aware in Oxlint and require the type-aware setup described in the Oxlint
docs.
#### Unsupported rules
The following ESLint rules/plugins from this config are not yet available in
Oxlint, so they are intentionally omitted:
- import/order
-
-
- (falls back to eslint/no-unused-vars)testing-library/*
-
-
- (except vitest/no-import-node-test)playwright/*`
-
MIT
[build-badge]: https://img.shields.io/github/actions/workflow/status/epicweb-dev/config/release.yml?branch=main&logo=github&style=flat-square
[build]: https://github.com/epicweb-dev/config/actions?query=workflow%3Arelease
[license-badge]: https://img.shields.io/badge/license-MIT%20License-blue.svg?style=flat-square
[license]: https://github.com/epicweb-dev/config/blob/main/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://kentcdodds.com/conduct