Skip to content

Commit

Permalink
chore: fix typos in README.md (#15)
Browse files Browse the repository at this point in the history
Co-authored-by: Alireza Safaierad <[email protected]>
  • Loading branch information
ShayanTheNerd and ASafaeirad authored Oct 24, 2024
1 parent efb51e7 commit 55238db
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ $ npm install --save-dev @fullstacksjs/eslint-config eslint prettier

## Usage

To use the configuration all you need is exporting generated config by `init` function. The configuration reads the metadata from your root `package.json` file and automatically adds the rules and plugins that are needed.
To use the configuration, all you need is exporting the generated config by `init` function. The configuration reads the metadata from your root `package.json` file and automatically adds the rules and plugins that are needed.

### ESM

Expand Down Expand Up @@ -108,7 +108,7 @@ As illustrated, certain rules significantly increase linting time, potentially h

To conditionally disable expensive linting rules, you can modify your configuration as follows:

list of expensiveRules to be effected:
List of expensiveRules to be effected:

```
@typescript-eslint/no-floating-promises
Expand All @@ -131,11 +131,11 @@ export default init({

This approach ensures a smoother development experience while still enforcing rigorous code quality checks in environments where performance is less of a concern.

## Migration Guid
## Migration Guide

### to v10
### To v11

v10 drops support for ESLint v8 configuration and only ESLint v9 is supported, which means you should migrate to [ESlint Flat Config](https://eslint.org/docs/latest/extend/plugin-migration-flat-config):
v11 drops support for ESLint v8 configuration and only ESLint v9 is supported, which means you should migrate to [ESlint Flat Config](https://eslint.org/docs/latest/extend/plugin-migration-flat-config):

1. Move your configs to `eslint.config.js` file.
2. Use init API.
Expand Down

0 comments on commit 55238db

Please sign in to comment.