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)

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

+// functionality of the `includeIgnoreFile` in `@eslint/compat`. The only
+// discrepancy is the default name has been changed to reflect that it is
+// really eslintignore mode by default.
+describe("`includeIgnoreFile` compat with @eslint/compat", () => {


The tests for the object form options ({ mode: string, name: string }) seem to be missing?

This section of tests was copied verbatim from the @eslint/compat repo (with the one noted change). That version of includeIgnoreFile only supports a string for its second argument.

Oh, I see, though, it looks like I haven't added a test with that combination in the preceding section. I'll go ahead and add one 👍

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

mdjermanovic

LGTM, thanks! Leaving open for others to verify.

fasttime

Just some minor typos.

Co-authored-by: Francesco Trotta <github@fasttime.org>

Copilot

Pull request overview

This PR moves ignore-file utilities into @eslint/config-helpers by adding includeIgnoreFile() (with gitignore-relative support and multi-file support) and re-exporting convertIgnorePatternToMinimatch(), while deprecating the equivalents in @eslint/compat and updating @eslint/migrate-config to consume the new export.

Changes:

Add includeIgnoreFile() + convertIgnorePatternToMinimatch() implementation, docs, fixtures, and unit tests to @eslint/config-helpers.
Update @eslint/migrate-config to import convertIgnorePatternToMinimatch from @eslint/config-helpers and adjust dependencies.
Deprecate @eslint/compat ignore-file helpers and document the deprecation.

Reviewed changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/migrate-config/src/migrate-config.js	Switches `convertIgnorePatternToMinimatch` import to `@eslint/config-helpers`.
packages/migrate-config/package.json	Replaces `@eslint/compat` dependency with `@eslint/config-helpers`; removes `eslint` devDependency.
packages/config-helpers/tests/types/types.test.ts	Adds TS type-surface checks for `includeIgnoreFile()` overload/return types.
packages/config-helpers/tests/ignore-file.test.js	Adds unit tests for `includeIgnoreFile()` and `convertIgnorePatternToMinimatch()`.
packages/config-helpers/tests/fixtures/ignore-files/gitignore1.txt	Adds fixture ignore file used by new unit tests.
packages/config-helpers/src/index.js	Re-exports new ignore-file utilities from the package entrypoint.
packages/config-helpers/src/ignore-file.js	Implements `includeIgnoreFile()` (multi-file + basePath option) and `convertIgnorePatternToMinimatch()`.
packages/config-helpers/README.md	Documents `includeIgnoreFile()` usage, options, and multi-file behavior.
packages/compat/tests/ignore-file.test.js	Updates file header comment (test behavior unchanged).
packages/compat/src/ignore-file.js	Marks compat helpers as deprecated in JSDoc.
packages/compat/README.md	Adds deprecation notice for compat `includeIgnoreFile()` documentation section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Francesco Trotta <github@fasttime.org>

mdjermanovic

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

lumirlumir · 2026-04-26T11:34:41Z

+		throw new Error(
+			"The options argument to `includeIgnoreFile()` should be an object or a string.",
+		);
+	}
+
+	const gitignoreResolution = optionsObject.gitignoreResolution ?? false;
+	if (typeof gitignoreResolution !== "boolean") {
+		throw new Error(
+			"The `gitignoreResolution` option must be specified a boolean or omitted",
+		);
+	}
+
+	const name = optionsObject.name ?? `Imported .gitignore patterns`;
+	if (typeof name !== "string") {
+		throw new Error(


Suggested change

throw new Error(

"The options argument to `includeIgnoreFile()` should be an object or a string.",

);

}

const gitignoreResolution = optionsObject.gitignoreResolution ?? false;

if (typeof gitignoreResolution !== "boolean") {

throw new Error(

"The `gitignoreResolution` option must be specified a boolean or omitted",

);

}

const name = optionsObject.name ?? `Imported .gitignore patterns`;

if (typeof name !== "string") {

throw new Error(

throw new TypeError(

"The options argument to `includeIgnoreFile()` should be an object or a string.",

);

}

const gitignoreResolution = optionsObject.gitignoreResolution ?? false;

if (typeof gitignoreResolution !== "boolean") {

throw new TypeError(

"The `gitignoreResolution` option must be specified a boolean or omitted",

);

}

const name = optionsObject.name ?? `Imported .gitignore patterns`;

if (typeof name !== "string") {

throw new TypeError(

Maybe TypeError would be more specific here? When checking an argument’s type, TypeError seems more precise, and it looks like other places follow the TypeError approach for argument validation as well.

rewrite/packages/config-helpers/src/global-ignores.js

Lines 30 to 36 in c872ca8

if (!Array.isArray(ignorePatterns)) {

throw new TypeError("ignorePatterns must be an array");

}

if (ignorePatterns.length === 0) {

throw new TypeError("ignorePatterns must contain at least one pattern");

}

It’s an optional suggestion, but I think adding a TypeError check to the tests would be a nice-to-have here.

assert.throws( () => includeIgnoreFile(123), { name: "TypeError", message: /error message/, }, );

lumirlumir · 2026-04-26T11:41:17Z

+			throw new Error(
+				"The first argument to `includeIgnoreFile()` should be a string or array of strings",
+			);
+		}
+		if (!path.isAbsolute(ignorePath)) {
+			throw new Error(


Suggested change

throw new Error(

"The first argument to `includeIgnoreFile()` should be a string or array of strings",

);

}

if (!path.isAbsolute(ignorePath)) {

throw new Error(

throw new TypeError(

"The first argument to `includeIgnoreFile()` should be a string or array of strings",

);

}

if (!path.isAbsolute(ignorePath)) {

throw new TypeError(

Same here :)

lumirlumir · 2026-04-26T12:02:32Z

+			const ignoreFilePath = fileURLToPath(
+				new URL(
+					"../tests/fixtures/ignore-files/gitignore1.txt",
+					import.meta.url,
+				),
+			);


Would it make sense to extract ignoreFilePath into a top-level helper variable here?

It looks like ignoreFilePath is used six times across the tests, so I think moving it could make the code a bit more concise.

lumirlumir · 2026-04-26T12:04:10Z

+					import.meta.url,
+				),
+			);
+			const basePath = fileURLToPath(


Moving basePath to the top level could also be a nice option, since it’s used twice (though I’m not strongly opinionated about it).

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

Open

9 tasks

kirkwaiblinger mentioned this pull request Apr 8, 2026

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

Draft

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/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

mdjermanovic previously approved these changes Apr 14, 2026

View reviewed changes

fasttime reviewed Apr 15, 2026

View reviewed changes

Comment thread packages/compat/src/ignore-file.js Outdated

fasttime reviewed Apr 15, 2026

View reviewed changes

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

fasttime reviewed Apr 15, 2026

View reviewed changes

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

update stale comment

8dabd37

kirkwaiblinger dismissed mdjermanovic’s stale review via 8dabd37 April 15, 2026 16:45

update typing and jsdoc

ed0e79b

kirkwaiblinger requested a review from fasttime April 15, 2026 17:06

fasttime reviewed Apr 18, 2026

View reviewed changes

Comment thread packages/config-helpers/tests/types/types.test.ts Outdated

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/src/ignore-file.js Outdated

kirkwaiblinger and others added 2 commits April 18, 2026 15:30

Update packages/config-helpers/src/ignore-file.js

4a63985

Co-authored-by: Francesco Trotta <github@fasttime.org>

Update packages/config-helpers/src/ignore-file.js

98141bd

Co-authored-by: Francesco Trotta <github@fasttime.org>

lumirlumir requested changes Apr 19, 2026

View reviewed changes

Comment thread packages/compat/README.md

Comment thread packages/config-helpers/README.md

Comment thread packages/config-helpers/tests/types/types.test.ts

lumirlumir requested a review from Copilot April 19, 2026 14:43

Copilot started reviewing on behalf of lumirlumir April 19, 2026 14:43 View session

Copilot AI reviewed Apr 19, 2026

View reviewed changes

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

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

Comment thread packages/config-helpers/tests/types/types.test.ts

Comment thread packages/config-helpers/src/index.js

kirkwaiblinger and others added 6 commits April 20, 2026 12:47

deprecated

a3af3c2

Update packages/config-helpers/tests/types/types.test.ts

5ec1eb1

Co-authored-by: Francesco Trotta <github@fasttime.org>

convertIgnorePatternToMinimatch type tests

ab0c58e

add redundant test that exports are exported

c3a24c2

true placeholder strings in type tests

a49ef42

tweak input validation

e2fd6b4

kirkwaiblinger requested a review from lumirlumir April 20, 2026 19:20

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

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

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

	if (!Array.isArray(ignorePatterns)) {
	throw new TypeError("ignorePatterns must be an array");
	}

	if (ignorePatterns.length === 0) {
	throw new TypeError("ignorePatterns must contain at least one pattern");
	}

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

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!

fasttime left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

kirkwaiblinger commented Apr 8, 2026 •

edited

Loading