Change Request: Utility function to read gitignore files

[nzakas]

Which packages would you like to change?

• [X] @eslint/compat
• [ ] @eslint/config-array
• [ ] @eslint/migrate-config
• [ ] @eslint/object-schema

What problem do you want to solve?

In v8, people pass --ignore-path .gitignore in order to use .gitignore patterns with ESLint.

In v9, there is no obvious way to use the .gitignore patterns in an eslint.config.js file, leaving people confused.

What do you think is the correct solution?

1. Copy the conversion function from migrate-config into compat and export it, making it available to end users.
2. Export an includeIgnoreFile() function that reads in an ignore file and automatically converts into the format that the config file needs, such that we can do this:

export default [
    await includeIgnoreFile(".gitignore", __dirname),

    // other configs here

];

Participation

• [X] I am willing to submit a pull request for this change.

Additional comments

No response

[mdjermanovic]

Makes sense to me, marked as accepted.

await includeIgnoreFile(".gitignore", __dirname),

I'm wondering if this function needs to be async, as that would make the use of it complicated in CommonJS config files.

[nzakas]

I suppose we could do it synchronously.

[nzakas]

Working on this.

[wong2]

How about reading multiple .gitignore files? I have a monorepo where each package has its own .gitignore file.