Support ignoreIssues per workspace (resolve #1782)

webpro · webpro · commit 15a329a0555b · 2026-06-15T11:29:03.000+02:00
diff --git a/packages/docs/src/content/docs/features/monorepos-and-workspaces.md b/packages/docs/src/content/docs/features/monorepos-and-workspaces.md
@@ -91,11 +91,12 @@ The following options are available inside workspace configurations:
 - [ignore][4]
 - [ignoreBinaries][5]
 - [ignoreDependencies][6]
-- [ignoreMembers][7]
-- [ignoreUnresolved][8]
-- [includeEntryExports][9]
+- [ignoreIssues][7]
+- [ignoreMembers][8]
+- [ignoreUnresolved][9]
+- [includeEntryExports][10]
 
-[Plugins][10] can be configured separately per workspace.
+[Plugins][11] can be configured separately per workspace.
 
 Use `--debug` for verbose output and see the workspaces Knip includes, their
 configurations, enabled plugins, glob options and resolved files.
@@ -133,7 +134,7 @@ workspaces. For two reasons:
 
 To lint the workspace in isolation, there are two options:
 
-- Combine the `workspace` argument with [strict production mode][11].
+- Combine the `workspace` argument with [strict production mode][12].
 - Run Knip from inside the workspace directory.
 
 [1]: ../overview/configuration.md#defaults
@@ -142,8 +143,9 @@ To lint the workspace in isolation, there are two options:
 [4]: ../reference/configuration.md#ignore
 [5]: ../reference/configuration.md#ignorebinaries
 [6]: ../reference/configuration.md#ignoredependencies
-[7]: ../reference/configuration.md#ignoremembers
-[8]: ../reference/configuration.md#ignoreunresolved
-[9]: ../reference/configuration.md#includeentryexports
-[10]: ../reference/configuration.md#plugins
-[11]: ./production-mode.md#strict-mode
+[7]: ../reference/configuration.md#ignoreissues
+[8]: ../reference/configuration.md#ignoremembers
+[9]: ../reference/configuration.md#ignoreunresolved
+[10]: ../reference/configuration.md#includeentryexports
+[11]: ../reference/configuration.md#plugins
+[12]: ./production-mode.md#strict-mode
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/knip.json b/packages/knip/fixtures/ignore/issues-workspaces/knip.json
@@ -0,0 +1,10 @@
+{
+  "$schema": "../../schema.json",
+  "workspaces": {
+    "packages/apple": {
+      "ignoreIssues": {
+        "helpers.ts": ["exports"]
+      }
+    }
+  }
+}
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/package.json b/packages/knip/fixtures/ignore/issues-workspaces/package.json
@@ -0,0 +1,5 @@
+{
+  "name": "@fixtures/ignore-issues-workspaces",
+  "private": true,
+  "workspaces": ["packages/*"]
+}
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/helpers.ts b/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/helpers.ts
@@ -0,0 +1 @@
+export const unusedApple = () => 'unused';
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/index.ts b/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/index.ts
@@ -0,0 +1 @@
+import './helpers.js';
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/package.json b/packages/knip/fixtures/ignore/issues-workspaces/packages/apple/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "apple"
+}
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/helpers.ts b/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/helpers.ts
@@ -0,0 +1 @@
+export const unusedBanana = () => 'unused';
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/index.ts b/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/index.ts
@@ -0,0 +1 @@
+import './helpers.js';
diff --git a/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/package.json b/packages/knip/fixtures/ignore/issues-workspaces/packages/banana/package.json
@@ -0,0 +1,3 @@
+{
+  "name": "banana"
+}
diff --git a/packages/knip/schema.json b/packages/knip/schema.json
@@ -316,6 +316,19 @@
         "ignoreExportsUsedInFile": {
           "$ref": "#/definitions/ignoreExportsUsedInFile"
         },
+        "ignoreIssues": {
+          "title": " Ignore specific issue types for specific file patterns (relative to the workspace root)",
+          "examples": [
+            {
+              "src/generated/**": ["exports", "types"],
+              "**/*.generated.ts": ["exports"]
+            }
+          ],
+          "type": "object",
+          "additionalProperties": {
+            "$ref": "#/definitions/issueTypes"
+          }
+        },
         "includeEntryExports": {
           "$ref": "#/definitions/includeEntryExports"
         }
diff --git a/packages/knip/src/ConfigurationChief.ts b/packages/knip/src/ConfigurationChief.ts
@@ -3,6 +3,7 @@ import type { SyncCompilers } from './compilers/types.ts';
 import { DEFAULT_EXTENSIONS, ROOT_WORKSPACE_NAME } from './constants.ts';
 import type {
   Configuration,
+  IgnoreIssues,
   IgnorePatterns,
   PluginsConfiguration,
   RawConfiguration,
@@ -17,7 +18,7 @@ import { arrayify, compact, partition } from './util/array.ts';
 import type { MainOptions } from './util/create-options.ts';
 import { createWorkspaceGraph, type WorkspaceGraph } from './util/create-workspace-graph.ts';
 import { isDirectory, isFile } from './util/fs.ts';
-import { _dirGlob, removeProductionSuffix } from './util/glob.ts';
+import { _dirGlob, prependDirToPattern, removeProductionSuffix } from './util/glob.ts';
 import { graphSequencer } from './util/graph-sequencer.ts';
 import mapWorkspaces from './util/map-workspaces.ts';
 import { join, relative } from './util/path.ts';
@@ -411,6 +412,20 @@ export class ConfigurationChief {
     return { ignoreBinaries, ignoreDependencies, ignoreUnresolved };
   }
 
+  public getIgnoreIssues() {
+    const ignoreIssues: IgnoreIssues = { ...this.config.ignoreIssues };
+    for (const name of this.availableWorkspaceNames) {
+      if (name === ROOT_WORKSPACE_NAME) continue;
+      const workspaceIgnoreIssues = this.getWorkspaceConfig(name).ignoreIssues;
+      if (!workspaceIgnoreIssues) continue;
+      for (const [pattern, issueTypes] of Object.entries(workspaceIgnoreIssues)) {
+        const id = prependDirToPattern(name, pattern);
+        ignoreIssues[id] = ignoreIssues[id] ? [...ignoreIssues[id], ...issueTypes] : issueTypes;
+      }
+    }
+    return ignoreIssues;
+  }
+
   public getConfigForWorkspace(workspaceName: string, extensions?: string[]) {
     const baseConfig = getDefaultWorkspaceConfig(extensions);
     const workspaceConfig = this.getWorkspaceConfig(workspaceName);
diff --git a/packages/knip/src/IssueCollector.ts b/packages/knip/src/IssueCollector.ts
@@ -3,6 +3,7 @@ import type { IgnoreIssues } from './types/config.ts';
 import type { ConfigurationHint, ConfigurationHints, Issue, IssueType, Rules, TagHint } from './types/issues.ts';
 import { partition } from './util/array.ts';
 import type { MainOptions } from './util/create-options.ts';
+import { prependDirToPattern } from './util/glob.ts';
 import { initCounters, initIssues } from './util/issue-initializers.ts';
 import { relative } from './util/path.ts';
 import type { WorkspaceFilePathFilter } from './util/workspace-file-filter.ts';
@@ -100,11 +101,12 @@ export class IssueCollector {
     // Pre-compile matchers for each issue type
     const issueTypePatterns = new Map<IssueType, string[]>();
     for (const [pattern, issueTypes] of Object.entries(ignoreIssues)) {
+      const id = prependDirToPattern(this.cwd, pattern);
       for (const issueType of issueTypes) {
         if (!issueTypePatterns.has(issueType)) {
           issueTypePatterns.set(issueType, []);
         }
-        issueTypePatterns.get(issueType)?.push(pattern);
+        issueTypePatterns.get(issueType)?.push(id);
       }
     }
 
@@ -116,7 +118,7 @@ export class IssueCollector {
   private shouldIgnoreIssue(filePath: string, issueType: IssueType): boolean {
     const matcher = this.issueMatchers.get(issueType);
     if (!matcher) return false;
-    return matcher(relative(this.cwd, filePath));
+    return matcher(filePath);
   }
 
   addFileCounts({ processed, unused }: { processed: number; unused: number }) {
diff --git a/packages/knip/src/run.ts b/packages/knip/src/run.ts
@@ -43,7 +43,7 @@ export const run = async (options: MainOptions) => {
   const principal = new ProjectPrincipal(options, toSourceFilePath, findWorkspaceManifestImports);
 
   collector.setWorkspaceFilter(chief.workspaceFilePathFilter);
-  collector.setIgnoreIssues(chief.config.ignoreIssues);
+  collector.setIgnoreIssues(chief.getIgnoreIssues());
 
   debugLogObject('*', 'Included workspaces', () => workspaces.map(w => w.pkgName));
   debugLogObject('*', 'Included workspace configs', () =>
diff --git a/packages/knip/src/schema/configuration.ts b/packages/knip/src/schema/configuration.ts
@@ -265,6 +265,11 @@ const rootConfigurationSchema = z.object({
    * This allows ignoring specific issues (like unused exports) in generated
    * files while still reporting other issues in those same files.
    *
+   * @remarks
+   * Set this option at root level to apply globally, or within workspace
+   * configurations individually. Workspace-level patterns are relative to the
+   * workspace root.
+   *
    * @see {@link https://knip.dev/reference/configuration#ignoreissues}
    */
   ignoreIssues: z.optional(ignoreIssuesSchema),
@@ -417,6 +422,7 @@ const baseWorkspaceConfigurationSchema = z.object({
   ignoreMembers: z.optional(stringOrRegexSchema),
   ignoreUnresolved: z.optional(stringOrRegexSchema),
   ignoreExportsUsedInFile: z.optional(ignoreExportsUsedInFileSchema),
+  ignoreIssues: z.optional(ignoreIssuesSchema),
   includeEntryExports: z.optional(z.boolean()),
 });
 
diff --git a/packages/knip/test/ignore/issues-workspaces.test.ts b/packages/knip/test/ignore/issues-workspaces.test.ts
@@ -0,0 +1,23 @@
+import assert from 'node:assert/strict';
+import test from 'node:test';
+import { main } from '../../src/index.ts';
+import baseCounters from '../helpers/baseCounters.ts';
+import { createOptions } from '../helpers/create-options.ts';
+import { resolve } from '../helpers/resolve.ts';
+
+const cwd = resolve('fixtures/ignore/issues-workspaces');
+
+test('Ignore issue types per workspace (paths relative to workspace root)', async () => {
+  const options = await createOptions({ cwd });
+  const { issues, counters } = await main(options);
+
+  assert(!issues.exports['packages/apple/helpers.ts']?.['unusedApple']);
+  assert(issues.exports['packages/banana/helpers.ts']?.['unusedBanana']);
+
+  assert.deepEqual(counters, {
+    ...baseCounters,
+    exports: 1,
+    processed: 4,
+    total: 4,
+  });
+});

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const unusedApple = () => 'unused';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export const unusedBanana = () => 'unused';`