Skip to content
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

Update README for eslint.config.js #169

Merged
merged 2 commits into from
Feb 9, 2023
Merged

Update README for eslint.config.js #169

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
391f3a9
Update README for `eslint.config.js`
scarf005 Feb 7, 2023
8370875
Update README.md
scarf005 Feb 9, 2023
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

# eslint-define-config

Provide a `defineConfig` function for `.eslintrc.js` files.
Provide a `defineConfig` function for `.eslintrc.js`, and a `defineFlatConfig` function for `eslint.config.js` files.

> This project is written by a human and only partially automatically generated!
> Some rules are even enhanced by hand!
Expand Down Expand Up @@ -59,6 +59,8 @@ module.exports = defineConfig({

## Flat Config

`eslint.config.js`

```ts
// @ts-check
const { defineFlatConfig } = require('eslint-define-config');
Expand All @@ -81,7 +83,7 @@ module.exports = defineFlatConfig([
Improve your eslint configuration experience with:

- auto-suggestions
- type checking (Use `// @ts-check` at the first line in your `.eslintrc.js`)
- type checking (Use `// @ts-check` at the first line in your `.eslintrc.js` or `eslint.config.js`)
- documentation
- deprecation warnings

Expand Down