Skip to content

docs: incomplete config example #1463

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michaelfaith merged 5 commits into from
Dec 22, 2025
Merged

docs: incomplete config example #1463

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
581d156
fix(docs): incomplete config example
OlivierZal Dec 22, 2025
8af12fc
harmonize doc examples with `defineConfig`
OlivierZal Dec 22, 2025
03e3ea4
fix
OlivierZal Dec 22, 2025
794ae5f
Merge branch 'main' into patch-1
OlivierZal Dec 22, 2025
de57dbc
run formatter
michaelfaith Dec 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,18 @@ If you want to override the recommended rules:
```ts
// eslint.config.ts
import packageJson from "eslint-plugin-package-json";
import { defineConfig } from "eslint/config";

export default [
export default defineConfig(
// your other ESLint configurations
packageJson.configs.recommended,
{
extends: [packageJson.configs.recommended],
files: ["package.json"],
rules: {
"package-json/valid-package-definition": "off",
"package-json/require-author": "error",
},
},
];
);
```

See [ESLint's _Configuration Files_ guide](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details on how to customize your rules and other config settings.
Expand Down
Loading