https://github.com/directus/eslint-config
Shared ESLint config used in Directus projects
https://github.com/directus/eslint-config
Last synced: 4 months ago
JSON representation
Shared ESLint config used in Directus projects
- Host: GitHub
- URL: https://github.com/directus/eslint-config
- Owner: directus
- License: mit
- Created: 2024-08-01T15:18:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-29T06:18:36.000Z (9 months ago)
- Last Synced: 2025-10-02T10:46:40.976Z (9 months ago)
- Language: TypeScript
- Homepage: https://directus.github.io/eslint-config/
- Size: 2.18 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# 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](https://github.com/dprint/dprint))
- Contains recommended and hand-picked rules
- [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) - Linting of import/export syntax
- [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) - Rules for Node.js
- [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest) - Linting tests
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) - Best practice rules for JS/TS
- [eslint-stylistic](https://github.com/eslint-stylistic/eslint-stylistic) - Formatting rules
- and more...
- Includes [eslint-plugin-command](https://github.com/antfu/eslint-plugin-command) for one-off codemod
## Installation
```shell
pnpm add -D eslint @directus/eslint-config
```
## Usage
Create an [ESLint config file](https://eslint.org/docs/latest/use/configure/configuration-files) with the following
content:
_Minimal_
```js
export { default } from '@directus/eslint-config';
```
_When using additional config_
```js
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.
## Additional Resources
- [Directus Website](https://directus.io)
- [Directus GitHub Repository](https://github.com/directus/directus)