From 71e89a280a7d94b6cb5937c80c3dfb52443d281d Mon Sep 17 00:00:00 2001 From: Lars Kappert Date: Fri, 5 Jul 2024 08:53:09 +0200 Subject: [PATCH] Add note to rules re. `dependencies` warning (#713) --- .../docs/features/rules-and-filters.md | 24 +++++++++++++++---- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/packages/docs/src/content/docs/features/rules-and-filters.md b/packages/docs/src/content/docs/features/rules-and-filters.md index 739321e59..8e68f1997 100644 --- a/packages/docs/src/content/docs/features/rules-and-filters.md +++ b/packages/docs/src/content/docs/features/rules-and-filters.md @@ -39,12 +39,23 @@ Also see the [list of issue types][2]. ### Shorthands -Use the `--dependencies` or `--exports` flag to combine groups of related types: +Knip has shortcuts to include only specific issue types. -- The `--dependencies` includes (dev) `dependencies`, `unlisted`, `binaries` and - `unresolved` -- The `--exports` flag has`exports`, `nsExports`, `classMembers`, `types`, - `nsTypes`, `enumMembers` and `duplicates` +1. The `--dependencies` flag includes: + + - `dependencies` (and `devDependencies` + `optionalPeerDependencies`) + - `unlisted` + - `binaries` + - `unresolved` + +2. The `--exports` flag includes: + + - `exports` + - `types` + - `enumMembers` + - `duplicates` + +3. The `--files` flag is a shortcut for `--include files` ## Rules @@ -71,6 +82,9 @@ Example: Also see the [issue types overview][2]. +NOTE: If the `dependencies` issue type is included, the `devDependencies` and +`optionalPeerDependencies` types can still be set to `"warn"` separately. + The rules are modeled after the ESLint `rules` configuration, and could be extended in the future.