🔄 5.58.1 breaks globs in entries

[dbartholomae]

Prerequisites

• I've read the relevant documentation
• I've searched for existing issues
• I've read the issue reproduction guide

Reproduction url

not yet

Reproduction access

• I've made sure the reproduction is publicly accessible

Good version

5.58.0

Bad version

5.58.1

Description of the regression

Currently I unfortunately don't have the time to create a reproduction, but wanted to at least let you know of the regression:

The entry definition apps/infrastructure/src/**/*.*Handler.ts no longer finds any files, e.g. apps/infrastructure/src/api/ApiStack.TrpcHandler.ts, leading to false-positive unused dependencies, devDependencies, exports, ...
When I run knip with the same config on 5.58.0, no unused dependencies show up.

[webpro]

That's actually a fix, if I'm correct: you're in a monorepo and apps/infrastructure is a workspace? You can see the (negated) glob patterns when using --debug.

[dbartholomae]

Not sure what you mean. I don't have any negated glob patterns that would match these files. Interestingly, when running with debug, they do show up in patterns and paths - but also in "Unused files".

[dbartholomae]

For additional context: In AWS CDK, you define both the infrastructure that you run on, and the code that should run on the infrastructure. The main entry point is for building the infrastructure, but every single AWS Lambda code file is its own entry. There's no defined name pattern, so I don't see a way for knip to automatically pick up which of these files are entry files for application code. Instead, I manually add each lambda handler as an entry point by following a naming scheme *Handler.ts and using a glob.

[webpro]

Knip adds the negated glob patterns to prevent files from other workspaces to match. This was already happening, but the fix is that, in your case, they went from apps/infrastructure to apps/infrastructure/**.

[dbartholomae]

Ok, so how should I configure this correctly? At the moment, I have one central knip file:

import type { KnipConfig } from "knip";

export default {
  entry: [
    // Allow lambda handlers as entry points
    "apps/infrastructure/src/**/*.*Handler.ts",
    "external/aws-constructs/src/**/*.*Handler.ts",

    // Storybook config files
    "./vitest.storybook.config.ts",
    "./.storybook/vitest.setup.ts",

    // Scripts that are not auto-detected
    "apps/client-portal/scripts/uploadSourceMapsToPosthog.ts",
  ],
  ignoreBinaries: [
    // Manually installed, mentioned in SETUP.md
    "sops",
  ],
  ignoreDependencies: [
    // Needed to bundle lambdas in AWS CDK
    "esbuild",
    // Used for precommit hooks
    "husky",
    // Used to run CDK synth
    "tsx",
    // Used by storybook to run tests
    "playwright",
    // Used by storybook as polyfill
    "crypto-js",
  ],
} satisfies KnipConfig;

As you thought, there are multiple projects in the workspace, e.g. infrastructure, was-constructs and client-portal.

[webpro]

Please see https://knip.dev/features/monorepos-and-workspaces

[dbartholomae]

Thanks! That solved it:

import type { KnipConfig } from "knip";

export default {
  workspaces: {
    ".": {
      entry: [
        // Storybook config files
        "./vitest.storybook.config.ts",
        "./.storybook/vitest.setup.ts",
      ],
      ignoreDependencies: [
        // Used for precommit hooks
        "husky",
        // Used by storybook to run tests
        "playwright",
        // Used by storybook as polyfill
        "crypto-js",
      ],
    },
    "apps/client-portal": {
      entry: [
        // Vite entry
        "./src/main.tsx",
        // Scripts that are not auto-detected
        "./scripts/uploadSourceMapsToPosthog.ts",
      ],
    },
    "apps/infrastructure": {
      entry: [
        // Allow lambda handlers as entry points
        "./src/**/*.*Handler.ts",
      ],
      ignoreBinaries: [
        // Manually installed, mentioned in SETUP.md
        "sops",
      ],
      ignoreDependencies: [
        // Needed to bundle lambdas in AWS CDK
        "esbuild",
        // Used to run CDK synth
        "tsx",
      ],
    },
    "external/aws-constructs": {
      entry: [
        // Allow lambda handlers as entry points
        "./src/**/*.*Handler.ts",
      ],
    },
  },
} satisfies KnipConfig;

[webpro]

Excellent! Btw, I'm working on #1105 that would've caught this early on.

[dbartholomae]

Nice! Great work overall! :)