feat: Add new `includeIgnoreFile()` to config-helpers by kirkwaiblinger · Pull Request #430 · eslint/rewrite

kirkwaiblinger · 2026-04-08T18:48:15Z

Prerequisites checklist

I have read the contributing guidelines.

AI acknowledgment

I did not use AI to generate this PR.
- (for the most part; some AI use for the added documentation)
(If the above is not checked) I have reviewed the AI-generated content before submitting.

What is the purpose of this pull request?

fixes #329

What changes did you make? (Give an overview)

Deprecate includeIgnoreFile(),convertIgnorePatternToMinimatch() in @eslint/compat. Add and export new includeIgnoreFile() (documented),convertIgnorePatternToMinimatch() (undocumented) in @eslint/config-helpers.

The new convertIgnorePatternToMinimatch() is unaltered.
The new includeIgnoreFile():

adds a gitignoreResolution option which can be false (default; interprets patterns relative to config file) or true (interprets patterns relative to ignore file).
can accept an array of ignore file paths rather than only a single ignore file path.

Related Issues

#329

Is there anything you'd like reviewers to focus on?

There is a companion PR in eslint repo: eslint/eslint#20735

DMartens · 2026-04-08T21:41:37Z

+		});
+
+		it("should return an object with an `ignores` property", () => {
+			const ignoreFilePath = fileURLToPath(


I think we should simplify this and in other spots by using import.meta.resolve (requires Node v18+)

Suggested change

const ignoreFilePath = fileURLToPath(

const ignoreFilePath = import.meta.resolve("../tests/fixtures/ignore-files/gitignore1.txt")

Huh... I never knew about import.meta.resolve. But in any case it looks like that still gets us a URL, which would need to be converted to a path with fileURLToPath(). So I'm not sure that that gains us anything? Unless I'm misunderstanding.

At the end of the day, this is really just the workaround for not having access to import.meta.dirname, which the linter complains about (due to supporting older versions of node)

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic

LGTM, thanks! Leaving open for others to verify their review comments.

lumirlumir

LGTM. Thanks for your time and effort on this PR!

Would like @mdjermanovic to verify the changes before merging.

Co-authored-by: 루밀LuMir <rpfos@naver.com>

mdjermanovic

LGTM, thanks! Leaving open for @fasttime and @DMartens to verify.

fasttime

LGTM.

DMartens · 2026-05-04T21:22:44Z

+			]);
+		});
+
+		// convert above to for ... of loop


I think this is an unresolved TODO comment related to line 61 which uses Array#forEach to create a parameterised test case.

Gah! that was a prompt to copilot that I forgot to remove, yep 🫣. Thanks for pointing that out.

DMartens · 2026-05-04T21:25:03Z

Changes LGTM, thank you for the continued work on this.
Only found a seemingly unresolved TODO comment.

##### [v2.1.0](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#210-2026-05-08) ##### Features - Add new `includeIgnoreFile()` to config-helpers ([#430](eslint/rewrite#430)) ([9b51352](eslint/rewrite@9b51352)) ##### [v2.0.5](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#205-2026-04-08) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.2.0 to ^1.2.1 ##### [v2.0.4](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#204-2026-04-03) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.1.1 to ^1.2.0 ##### [v2.0.3](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#203-2026-03-06) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.1.0 to ^1.1.1 ##### [v2.0.2](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#202-2026-01-29) ##### Bug Fixes - add eslint 10 as peer dependency ([#361](eslint/rewrite#361)) ([ecb37dc](eslint/rewrite@ecb37dc)) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.0.1 to ^1.1.0

##### [v2.1.1](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#211-2026-09-01) ##### Bug Fixes - preserve markVariableAsUsed return value in compat context ([#503](eslint/rewrite#503)) ([66d9790](eslint/rewrite@66d9790)) ##### [v2.1.0](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#210-2026-05-08) ##### Features - Add new `includeIgnoreFile()` to config-helpers ([#430](eslint/rewrite#430)) ([9b51352](eslint/rewrite@9b51352)) ##### [v2.0.5](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#205-2026-04-08) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.2.0 to ^1.2.1 ##### [v2.0.4](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#204-2026-04-03) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.1.1 to ^1.2.0 ##### [v2.0.3](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#203-2026-03-06) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.1.0 to ^1.1.1 ##### [v2.0.2](https://github.com/eslint/rewrite/blob/HEAD/packages/compat/CHANGELOG.md#202-2026-01-29) ##### Bug Fixes - add eslint 10 as peer dependency ([#361](eslint/rewrite#361)) ([ecb37dc](eslint/rewrite@ecb37dc)) ##### Dependencies - The following workspace dependencies were updated - dependencies - [@eslint/core](https://github.com/eslint/core) bumped from ^1.0.1 to ^1.1.0

kirkwaiblinger added 4 commits April 8, 2026 09:40

copy functionality from compat

d1118c6

deprecate old APIs

d973693

more deprecation documentation

eb8cada

changes

24e10cb

github-project-automation Bot added this to Triage Apr 8, 2026

github-project-automation Bot moved this to Needs Triage in Triage Apr 8, 2026

eslint-github-bot Bot added the feature label Apr 8, 2026

eslint-github-bot Bot mentioned this pull request Apr 8, 2026

Change Request: includeIgnoreFile should respect the path to the directory containing the .gitignore #329

Closed

1 of 9 tasks

kirkwaiblinger mentioned this pull request Apr 8, 2026

feat: add includeIgnoreFile() to eslint/config eslint/eslint#20735

Merged

2 of 3 tasks

kirkwaiblinger marked this pull request as ready for review April 8, 2026 19:30

kirkwaiblinger changed the title ~~feat: Add new includeIgnoreFIle() to config-helpers~~ feat: Add new includeIgnoreFile() to config-helpers Apr 8, 2026

lol why is that even allowed

66b5597

DMartens reviewed Apr 8, 2026

View reviewed changes

Comment thread packages/config-helpers/tests/ignore-file.test.js

DMartens reviewed Apr 8, 2026

View reviewed changes

Comment thread packages/config-helpers/src/ignore-file.js Outdated

kirkwaiblinger added 2 commits April 8, 2026 17:34

feedback

8caf15a

extract to function

45dd1b1

kirkwaiblinger requested a review from DMartens April 8, 2026 23:41

mdjermanovic added contributor pool accepted labels Apr 9, 2026

mdjermanovic moved this from Needs Triage to Implementing in Triage Apr 9, 2026

mdjermanovic reviewed Apr 9, 2026

View reviewed changes

Comment thread packages/compat/README.md Outdated

Update packages/compat/README.md

819308f

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

mdjermanovic reviewed Apr 9, 2026

View reviewed changes

Comment thread packages/compat/tests/ignore-file.test.js Outdated

mdjermanovic reviewed Apr 9, 2026

View reviewed changes

Comment thread packages/compat/README.md Outdated

mdjermanovic reviewed Apr 9, 2026

View reviewed changes

Comment thread packages/config-helpers/README.md Outdated

kirkwaiblinger added 3 commits April 9, 2026 10:20

fileoverview

7f1ab85

use standard markdown

122711f

update migrate-config

d00b460

kirkwaiblinger commented Apr 10, 2026

View reviewed changes

Comment thread packages/migrate-config/package.json

Merge branch 'main' into include-gitignore-in-path

0f85748

mdjermanovic previously approved these changes Apr 25, 2026

View reviewed changes

lumirlumir moved this from Implementing to Second Review Needed in Triage Apr 26, 2026

lumirlumir requested changes Apr 26, 2026

View reviewed changes

Comment thread packages/config-helpers/src/ignore-file.js Outdated

Comment thread packages/config-helpers/src/ignore-file.js Outdated

Comment thread packages/config-helpers/tests/ignore-file.test.js Outdated

Comment thread packages/config-helpers/tests/ignore-file.test.js Outdated

DRY tests and TypeErrors

b9ddf41

kirkwaiblinger dismissed mdjermanovic’s stale review via b9ddf41 April 27, 2026 19:05

defineConfig[

fa43e29

kirkwaiblinger requested a review from lumirlumir April 27, 2026 19:09

lumirlumir previously approved these changes May 4, 2026

View reviewed changes

Comment thread packages/config-helpers/README.md Outdated

Update packages/config-helpers/README.md

9d4461c

Co-authored-by: 루밀LuMir <rpfos@naver.com>

kirkwaiblinger dismissed lumirlumir’s stale review via 9d4461c May 4, 2026 15:21

mdjermanovic previously approved these changes May 4, 2026

View reviewed changes

fasttime previously approved these changes May 4, 2026

View reviewed changes

DMartens reviewed May 4, 2026

View reviewed changes

remove copilot prompt

8f99a34

kirkwaiblinger dismissed stale reviews from fasttime and mdjermanovic via 8f99a34 May 4, 2026 21:29

kirkwaiblinger requested a review from DMartens May 4, 2026 21:31

DMartens approved these changes May 4, 2026

View reviewed changes

DMartens merged commit 9b51352 into eslint:main May 4, 2026
59 checks passed

github-project-automation Bot moved this from Second Review Needed to Complete in Triage May 4, 2026

eslintbot mentioned this pull request May 4, 2026

chore: release main #446

Merged

kirkwaiblinger deleted the include-gitignore-in-path branch May 4, 2026 22:11

kirkwaiblinger mentioned this pull request May 4, 2026

Scheduled release for May 15th, 2026 eslint/eslint#20840

Closed

19 of 30 tasks

claude Bot mentioned this pull request May 15, 2026

build(deps-dev): update dependency @eslint/compat to v2.1.0 ncaq/surfingkeys-config#66

Merged

1 task

kirkwaiblinger mentioned this pull request May 16, 2026

feat!: migrate migrate-config to new includeIgnoreFile #457

Merged

2 of 3 tasks

tommyp mentioned this pull request Oct 1, 2026

chore(deps): update sveltekit, vite, vitest 5, sentry 11, and 18 others tommyp/is-it-shorts-weather-today#4

Merged

	const ignoreFilePath = fileURLToPath(
	const ignoreFilePath = import.meta.resolve("../tests/fixtures/ignore-files/gitignore1.txt")

Uh oh!

Conversation

kirkwaiblinger commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Prerequisites checklist

AI acknowledgment

What is the purpose of this pull request?

What changes did you make? (Give an overview)

Related Issues

Is there anything you'd like reviewers to focus on?

Uh oh!

DMartens Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

kirkwaiblinger Apr 8, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lumirlumir left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

fasttime left a comment

Choose a reason for hiding this comment

Uh oh!

DMartens May 4, 2026

Choose a reason for hiding this comment

Uh oh!

kirkwaiblinger May 4, 2026

Choose a reason for hiding this comment

Uh oh!

DMartens commented May 4, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kirkwaiblinger commented Apr 8, 2026 •

edited

Loading