@epic-web/config

👮 @epic-web/config

Reasonable ESLint, Prettier, and TypeScript configs for epic web devs

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

---

The problem

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 solution

This is a set of configurations you can use in your web projects to avoid wasting time.

Decisions

You can learn about the different decisions made for this project in the decision docs.

Usage

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).

Prettier

The easiest way to use this config is in your package.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:

import defaultConfig from '@epic-web/config/prettier'

/** @type {import("prettier").Options} */
export default {
	...defaultConfig,
	// .. your overrides here...
}

TypeScript

Create a tsconfig.json file in your project root with the following content:

{
	"extends": ["@epic-web/config/typescript"],
	"include": [
		"@epic-web/config/reset.d.ts",
		"**/*.ts",
		"**/*.tsx",
		"**/*.js",
		"**/*.jsx"
	],
	"compilerOptions": {
		"paths": {
			"#app/*": ["./app/*"],
			"#tests/*": ["./tests/*"]
		}
	}
}

Customizing TypeScript

Learn more from the TypeScript docs here.

ESLint

Create a eslint.config.js file in your project root with the following content:

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.

License

MIT