Skip to content

Commit

Permalink
docs: add information about the old-style usage
Browse files Browse the repository at this point in the history
  • Loading branch information
haoqunjiang committed Jan 11, 2025
1 parent e3ee63c commit 0895e73
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,12 @@ export default defineConfigWithVueTs(
)
```

## Use As a Normal Shared ESLint Config (Not Recommended)

You can use this package as a normal ESLint config, without the `defineConfigWithVueTs` helper. But in this case, overriding the rules for `.vue` files would be more difficult and comes with many nuances. Please be cautious.

You can check [the documentation for 14.1 and earlier versions](https://github.com/vuejs/eslint-config-typescript/tree/v14.1.4#usage) for more information.

## Further Reading

- [All the extendable configurations from `typescript-eslint`](https://typescript-eslint.io/users/configs).
Expand Down

0 comments on commit 0895e73

Please sign in to comment.