https://github.com/nicksp/eslint-config
Nick's ESLint config preset
https://github.com/nicksp/eslint-config
eslint eslint-config eslint-flat-config
Last synced: 5 months ago
JSON representation
Nick's ESLint config preset
- Host: GitHub
- URL: https://github.com/nicksp/eslint-config
- Owner: nicksp
- License: mit
- Created: 2025-09-10T21:06:45.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-02-27T13:46:56.000Z (5 months ago)
- Last Synced: 2026-02-27T15:08:26.368Z (5 months ago)
- Topics: eslint, eslint-config, eslint-flat-config
- Language: TypeScript
- Homepage:
- Size: 461 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# @nicksp/eslint-config
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Node.js CI status][ci-src]][ci-href]
[![pkg.pr.new][cr-src]][cr-href]
Shared ESLint config I use on my personal projects. Based on [antfu's config](https://github.com/antfu/eslint-config).
## Difference
- Format with Prettier
- Only the tools I use are supported
- More stricter rules
- Simpler setup
## Highlights
- Play well with TypeScript and Prettier
- Target tools I use personally on the majority of the projects: React, Next, Astro and Vitest
- Sort imports, `package.json`, `tsconfig.json`
- [ESLint flat config](https://eslint.org/docs/latest/use/configure/configuration-files) for better organization and composition
- Respects `.gitignore` by default
- Reasonable defaults, best practices, only one-line of config
- Requires ESLint v9.5.0+
## Setup
```shell
pnpm add -D eslint@latest @nicksp/eslint-config
```
Create `eslint.config.mjs` in your project root:
```js
import { defineConfig } from '@nicksp/eslint-config'
export default defineConfig()
```
Add scripts for `package.json`:
```json
{
"scripts": {
"lint": "eslint",
"lint:fix": "eslint --fix",
"format": "prettier --write \"**/*.{js,cjs,mjs,jsx,ts,tsx,astro,css,json,md}\""
}
}
```
Configure VS Code for auto-fix on save in `.vscode/settings.json`:
```jsonc
{
// Use the Prettier formatter
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
// Autosave files on focus change
"files.autoSave": "onFocusChange",
// Don’t autosave files with syntax errors
"files.autoSaveWhenNoErrors": true,
// Auto fix
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit",
"source.organizeImports": "never"
},
// Silent the stylistic rules in your IDE, but still auto fix them
"eslint.rules.customizations": [
{ "rule": "style/*", "severity": "off", "fixable": true },
{ "rule": "format/*", "severity": "off", "fixable": true },
{ "rule": "*-indent", "severity": "off", "fixable": true },
{ "rule": "*-spacing", "severity": "off", "fixable": true },
{ "rule": "*-spaces", "severity": "off", "fixable": true },
{ "rule": "*-order", "severity": "off", "fixable": true },
{ "rule": "*-dangle", "severity": "off", "fixable": true },
{ "rule": "*-newline", "severity": "off", "fixable": true },
{ "rule": "*quotes", "severity": "off", "fixable": true },
{ "rule": "*semi", "severity": "off", "fixable": true }
],
// Enable eslint for all supported languages
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
"html",
"markdown",
"json",
"json5",
"jsonc",
"yaml",
"toml",
"xml",
"gql",
"graphql",
"astro",
"css",
"less",
"scss",
"pcss",
"postcss"
]
}
```
## Usage
```js
// eslint.config.js
import { defineConfig } from '@nicksp/eslint-config'
export default defineConfig(
{
// Type of the project. 'lib' for libraries, the default is 'app'
type: 'lib',
// Formatting with Prettier is enabled by default, you can disable it
prettier: false,
// TypeScript is autodetected, you can also explicitly enable it
typescript: true,
// Disable jsx support
jsx: false,
// You can configure each integration individually as well
yaml: {
overrides: {
// ...
},
},
ignores: [
'**/fixtures',
// ...globs
]
},
// You can have multiple config overrides
{
files: ['**/*.ts'],
rules: {},
},
{
rules: {},
},
)
// Advanced config
// See more at https://github.com/antfu/eslint-flat-config-utils
.prepend(
// some configs before the main config
).removeRules('foo/bar')
```
### Optional configs
These are optional configs for specific use cases.
Running `npx eslint` should prompt you to install the required dependencies, otherwise, you can install them manually.
```js
// eslint.config.js
import { defineConfig } from '@nicksp/eslint-config'
export default defineConfig({
// Enable React support
react: true,
// Enable Next.js support
nextjs: true,
// Enable Astro support
astro: true,
})
```
## Other Projects You Might Like
- [nicksp/dotfiles](https://github.com/nicksp/dotfiles/) - My dotfiles and VS Code settings
- [nicksp/prettier-config](https://github.com/nicksp/prettier-config) - My Prettier config
- [nicksp/renovate-config](https://github.com/nicksp/renovate-config) - My Renovate config
- [nicksp/workflows](https://github.com/nicksp/workflows) - Reusable GitHub Actions workflows
## License
[MIT](LICENSE) License © 2025 [Nick Plekhanov](https://plekhanov.me)
[npm-version-src]:
[npm-version-href]:
[npm-downloads-src]:
[npm-downloads-href]:
[ci-src]:
[ci-href]:
[cr-src]:
[cr-href]: