Skip to content

Commit

Permalink
Readme: listing the ability to use multiconfig.
Browse files Browse the repository at this point in the history
  • Loading branch information
RobinTail committed Feb 20, 2025
1 parent c3a2e80 commit 3b35998
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ import fancyFn from "unlisted-module"; // Error: Importing unlisted-module is no
cannot, and not specifically, but by category.
- Unlike `no-extraneous-dependencies` of `eslint-plugin-import` plugin, it supports ESLint 9 and its flat config.
- Unlike same rule of `eslint-plugin-import-x` plugin, it does not require to install a typescript resolver to operate.
- The plugin also supports reading multiple `package.json`.

# Quick start

Expand Down Expand Up @@ -105,14 +106,15 @@ Supply the options this way:
typeOnly: [],
ignore: ["^\\.", "^node:"],
},
// {...} — you can add more (workspaces?)
],
},
}
```

By default, the plugin is configured for checking the source code based on the `package.json` located in the current
working directory of the ESLint process. Production dependencies and mandatory peers are allowed to import,
but optional peers are allowed to be imported only as types.
but optional peers and development modules are allowed to be imported only as types.

```yaml
packageDir:
Expand Down

0 comments on commit 3b35998

Please sign in to comment.