@jpapini/eslint-config/configs/ignore-config.js

Custom ESLint configuration for JavaScript and TypeScript projects.

import fs from 'node:fs';
import path from 'node:path';

import { includeIgnoreFile } from '@eslint/compat';
import memoizeOne from 'memoize-one';
import tseslint from 'typescript-eslint';

/**
 * Find the .gitignore file in the current directory or any parent directories
 * @param {string} [currentDir] The current directory to start searching for the .gitignore file
 * @returns {string | null} The path to the .gitignore file or null if it doesn't exist
 */
function _findGitIgnore(currentDir) {
    let dir = currentDir ?? process.cwd();

    while (dir !== '/') {
        if (fs.existsSync(path.join(dir, '.gitignore'))) return path.join(dir, '.gitignore');
        if (fs.existsSync(path.join(dir, '.git'))) return null;
        dir = path.dirname(dir);
    }

    return null;
}

// @ts-ignore - memoize-one wrongly typed its default export
const findGitIgnore = memoizeOne(_findGitIgnore);

/**
 * Ignore files that are in the .gitignore file
 * @url https://eslint.org/docs/latest/use/configure/ignore#including-gitignore-files
 * @param {string} rootDir The root directory of the project
 */
export default (rootDir) => {
    const gitIgnorePath = findGitIgnore(rootDir);
    const ignoreConfig = gitIgnorePath !== null ? includeIgnoreFile(gitIgnorePath) : {};

    return tseslint.config({
        name: 'ignore-config',
        extends: [ignoreConfig],
    });
};