feat: add support for custom name parameter to includeIgnoreFile

packages/compat/src/ignore-file.js

@@ -68,10 +68,11 @@ export function convertIgnorePatternToMinimatch(pattern) {
 /**
  * Reads an ignore file and returns an object with the ignore patterns.
  * @param {string} ignoreFilePath The absolute path to the ignore file.
+ * @param {string} [name] The name of the ignore file config.
  * @returns {FlatConfig} An object with an `ignores` property that is an array of ignore patterns.
  * @throws {Error} If the ignore file path is not an absolute path.
  */
-export function includeIgnoreFile(ignoreFilePath) {
+export function includeIgnoreFile(ignoreFilePath, name) {
 	if (!path.isAbsolute(ignoreFilePath)) {
 		throw new Error("The ignore file location must be an absolute path.");
 	}
@@ -80,7 +81,7 @@ export function includeIgnoreFile(ignoreFilePath) {
 	const lines = ignoreFile.split(/\r?\n/u);
 
 	return {
-		name: "Imported .gitignore patterns",
+		name: name || "Imported .gitignore patterns",
 		ignores: lines
 			.map(line => line.trim())
 			.filter(line => line && !line.startsWith("#"))

packages/compat/tests/ignore-file.js

@@ -88,5 +88,28 @@ describe("@eslint/compat", () => {
 				],
 			});
 		});
+
+		it("should return an object with a custom name", () => {
+			const ignoreFilePath = fileURLToPath(
+				new URL(
+					"../tests/fixtures/ignore-files/gitignore1.txt",
+					import.meta.url,
+				),
+			);
+			const result = includeIgnoreFile(ignoreFilePath, "Custom Name");
+			assert.deepStrictEqual(result, {
+				name: "Custom Name",
+				ignores: [
+					"**/node_modules",
+					"!fixtures/node_modules",
+					"dist",
+					"**/*.log",
+					"**/.cache/",
+					".vuepress/dist",
+					"*/foo.js",
+					"dir/**/*",
+				],
+			});
+		});
 	});
 });

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

@@ -24,6 +24,7 @@ let globalIgnoreCount = 0;
  * @param {string[]} ignorePatterns The ignore patterns.
  * @param {string} [name] The name of the global ignores config.
  * @returns {Config} The global ignores config.
+ * @throws {TypeError} If ignorePatterns is not an array or if it is empty.
  */
 export function globalIgnores(ignorePatterns, name) {
 	if (!Array.isArray(ignorePatterns)) {