GitHub - directus/eslint-config: Shared ESLint config used in Directus projects · GitHub

main

Go to file

Code

NameName

Last commit message

Last commit date

Latest commit History 31 Commits
.github		.github
.vscode		.vscode
fixtures		fixtures
scripts		scripts
src		src
test		test
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmrc		.npmrc
eslint.config.ts		eslint.config.ts
license		license
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
readme.md		readme.md
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts
View all files

Repository files navigation

More items

Directus ESLint Config

Opinionated ESLint config used by the projects in the Directus ecosystem.

Lint and format JS/TS, Vue, JSON, YAML and TOML files (via ESLint)
Format HTML, CSS/SCSS, MD and GQL files (via dprint)
Contains recommended and hand-picked rules
- eslint-plugin-import-x - Linting of import/export syntax
- eslint-plugin-n - Rules for Node.js
- eslint-plugin-vitest - Linting tests
- eslint-plugin-unicorn - Best practice rules for JS/TS
- eslint-stylistic - Formatting rules
- and more...
Includes eslint-plugin-command for one-off codemod

Installation

pnpm add -D eslint @directus/eslint-config

Usage

Create an ESLint config file with the following content:

Minimal

export { default } from '@directus/eslint-config';

When using additional config

import directusConfig from '@directus/eslint-config';

export default [
	...directusConfig,
	// Additional config
];

Credits

This config is heavily inspired by and partially based on Anthony's ESLint config preset ❤️
If you're looking for an ESLint config preset outside of the Directus ecosystem, check it out at https://github.com/antfu/eslint-config.

Credits also go to all maintainers of the ESLint plugins this config is using.