<div> <h1 align="center"><a href="https://npm.im/@epic-web/config">👮 @epic-web/config</a></h1> <strong> Reasonable Oxlint, Prettier, and TypeScript configs for epic web devs </strong> <p> This makes assumptions about the way you prefer to develop software and gives you configurations that will actually help you in your development. </p> </div>

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 package provides shared defaults for the tools this repo currently ships:

Oxlint
Prettier
TypeScript

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"

<details> <summary>Customizing Prettier</summary>

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

</details>

TypeScript

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

{
	"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:

import '@epic-web/config/reset.d.ts'

<details> <summary>Customizing TypeScript</summary>

Learn more from the TypeScript docs here.

</details>

Oxlint

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

{
	"extends": ["./node_modules/@epic-web/config/oxlint-config.json"]
}

This config includes the custom epic-web/* rules documented in lint-rules/index.md.

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.

Some Oxlint rule IDs still use the eslint/ namespace because that is how Oxlint exposes those compatibility rules. You do not need to install ESLint to use them.

Not yet covered

The following rule families are intentionally omitted because they are not yet part of the Oxlint config this package ships:

import/order
react-hooks/rules-of-hooks
react-hooks/exhaustive-deps
testing-library/*
jest-dom/*
most vitest/* rules
playwright/*

License

MIT

Config

Install / Use

README