Function checkIsFileGitIgnored

packages/utils/src/git-utils.ts:4–40

(path: string, warnIfNotGitRepo = false)

import { dirname } from 'node:path';

export async function checkIsFileGitIgnored(path: string, warnIfNotGitRepo = false) {
  try {
    // Use spawnAsync with array arguments to properly handle paths with spaces
    // Pass cwd to run git from the file's directory
    await spawnAsync('git', ['check-ignore', path, '-q'], { cwd: dirname(path) });
    return true;
  } catch (err) {
    // git binary not found (not installed or not in PATH) - check this first
    // before accessing err.data which won't exist on native spawn ENOENT errors
    if ((err as any).code === 'ENOENT') return undefined;

    const errorOutput = (err as any).data as string | undefined;
    // git is not installed, so we can't check
    if (
      (err as any).exitCode === 127
      || errorOutput?.includes('not found')
      || errorOutput?.includes('not recognized') // windows
    ) {
      return undefined;
    }
    // `git check-ignore -q` exits with code 1 but no other error if is not ignored
    if (errorOutput === '') return false;
    if (errorOutput?.includes('not a git repository')) {
      if (warnIfNotGitRepo) {
        // eslint-disable-next-line no-console
        console.log('🔶 Your code is not currently in a git repository - run `git init` to initialize a new repo.');
      }
      return false;
    }
    // file is outside the current git repository (e.g., importing from home directory)
    if (errorOutput?.includes('is outside repository')) {
      return undefined;
    }
    // otherwise we'll let it throw since something else is happening
    throw err;
  }
}