Fix ignored workspace matching

webpro-nl · Nov 26, 2024 · 1c6309d · 1c6309d
1 parent fc88c1a
commit 1c6309d
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 5 deletions.
diff --git a/packages/docs/src/content/docs/reference/configuration.md b/packages/docs/src/content/docs/reference/configuration.md
@@ -219,7 +219,11 @@ Array of workspaces to ignore, globs allowed. Example:
 
 ```json title="knip.json"
 {
-  "ignoreWorkspaces": ["packages/ignore", "packages/examples/**"]
+  "ignoreWorkspaces": [
+    "packages/go-server",
+    "packages/flat/*"
+    "packages/deep/**"
+  ]
 }
 ```
 

diff --git a/packages/knip/fixtures/workspaces-ignored/package.json b/packages/knip/fixtures/workspaces-ignored/package.json
@@ -5,7 +5,11 @@
       "packages/c",
       "packages/d*",
       "packages/f",
-      "packages/g"
+      "packages/g",
+      "packages/deep/**",
+      "packages/flat/*",
+      "packages/un/**/used",
+      "packages/wut/*"
     ]
   }
 }
diff --git a/packages/knip/fixtures/workspaces-ignored/packages/deep/er/h2/package.json b/packages/knip/fixtures/workspaces-ignored/packages/deep/er/h2/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@workspaces-ignored/deep-h2",
+  "scripts": {
+    "start": "ignored"
+  }
+}
diff --git a/packages/knip/fixtures/workspaces-ignored/packages/flat/i1/package.json b/packages/knip/fixtures/workspaces-ignored/packages/flat/i1/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "@workspaces-ignored/flat-i1",
+  "scripts": {
+    "start": "ignored"
+  }
+}
diff --git a/packages/knip/fixtures/workspaces-ignored/pnpm-workspace.yaml b/packages/knip/fixtures/workspaces-ignored/pnpm-workspace.yaml
@@ -1,4 +1,6 @@
 packages:
   - 'packages/*'
+  - 'packages/flat/*'
+  - 'packages/deep/er/*'
   - '!packages/a'
   - '!packages/b*'
diff --git a/packages/knip/src/ConfigurationChief.ts b/packages/knip/src/ConfigurationChief.ts
@@ -254,8 +254,7 @@ export class ConfigurationChief {
     const ignoredWorkspacesManifest = this.getListedWorkspaces()
       .filter(name => name.startsWith('!'))
       .map(name => name.replace(/^!/, ''));
-    const ignoredWorkspacesConfig = this.config.ignoreWorkspaces.map(name => name.replace(/\/\*$/, ''));
-    return [...ignoredWorkspacesManifest, ...ignoredWorkspacesConfig];
+    return [...ignoredWorkspacesManifest, ...this.config.ignoreWorkspaces];
   }
 
   private getConfiguredWorkspaceKeys() {

diff --git a/packages/knip/test/workspaces-ignored.test.ts b/packages/knip/test/workspaces-ignored.test.ts
@@ -16,7 +16,14 @@ test('Ignore workspaces', async () => {
   assert.equal(Object.keys(issues.binaries).length, 1);
   assert(issues.binaries['packages/e/package.json']['not-ignored']);
 
-  assert.deepEqual(configurationHints, new Set([{ type: 'ignoreWorkspaces', identifier: 'packages/f' }]));
+  assert.deepEqual(
+    configurationHints,
+    new Set([
+      { type: 'ignoreWorkspaces', identifier: 'packages/f' },
+      { type: 'ignoreWorkspaces', identifier: 'packages/wut/*' },
+      { type: 'ignoreWorkspaces', identifier: 'packages/un/**/used' },
+    ])
+  );
 
   assert.deepEqual(counters, {
     ...baseCounters,