Respect .git/info/exclude in addition to .gitignore about knip HOT 10 OPEN

Thanks @weilbith!

I didn't know about .git/info/exclude, that looks useful indeed.

For now, you could consider using a dynamic knip.ts, read .git/info/exclude, and its items to knip ignore patterns (or as negated entry/project patterns).

from knip.

Wow, that was a fast reply! 😱
Thank you very much!

Ah, cool. That actually sounds like a sound idea!
I'll implement that for now. Do you think it will make it as a feature upstream? Should I contribute a PR?

In case someone stumbles across this issue and it is not (yet) implemented upstream, here is my version of adding it to my knip.ts configuration:

import { readFile } from "fs/promises";
import type { KnipConfig } from "knip";

// TODO: Remove once feature was implemented upstream.
async function readGitInfoExcludePatterns(): Promise<string[]> {
  const buffer = await readFile(".git/info/exclude");
  return buffer
    .toString("utf-8")
    .split(/\r\n|\r|\n/)
    .filter((line) => !!line.trim())
    .filter((line) => !line.startsWith("#"))
    .map((line) => (line.endsWith("/") ? `${line}**` : line));
}

export default async function composeConfiguration(): Promise<KnipConfig> {
  const gitInfoExcludePatterns = await readGitInfoExcludePatterns();

  return {
    ignore: [
      ...gitInfoExcludePatterns,
      // ... more patterns
    ],
    // ... more configuration
  };
}

from knip.

Thanks for sharing your solution!

Feel free to give this a shot. That part of the code is here: https://github.com/webpro/knip/blob/main/packages/knip/src/util/globby.ts#L59

from knip.

Feel free to give this a shot. That part of the code is here: https://github.com/webpro/knip/blob/main/packages/knip/src/util/globby.ts#L59

Hui, that's a function 😄
Let me see. Thinking about how to integrate it best. Because the current logic seem to be quite evolved, acting on various levels including the search for .gitignore files, while there is always only a single .git/info/exclude. 🤔

from knip.

Maybe you could consider something like moving everything inside the if clause of entryFilter to a separate function and call that function once for .git/info/exclude.

from knip.

@weilbith Is this still something you fancy picking up? I have absolutely no hurries with this one, just checking up.

from knip.