@w5s/eslint-config-ignore 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Julien Polo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# W5S ESLint ignore configuration _(@w5s/eslint-config-ignore)_
+
+[![NPM Version][package-version-svg]][package-url]
+[![License][license-image]][license-url]
+
+> Shared ignore configuration generator for ESLint presets.
+
+## Installation
+
+```console
+npm install --save-dev @w5s/eslint-config-ignore
+```
+
+## Usage
+
+```ts
+import { ignores } from '@w5s/eslint-config-ignore';
+
+export default [ignores()];
+```
+
+## API
+
+- `ignores(options?)`
+  - `options.ignores?: string[]`
+
+## License
+
+[MIT][license-url]
+
+[package-version-svg]: https://img.shields.io/npm/v/@w5s/eslint-config-ignore.svg?style=flat-square
+[package-url]: https://www.npmjs.com/package/@w5s/eslint-config-ignore
+[license-image]: https://img.shields.io/badge/license-MIT-green.svg?style=flat-square
+[license-url]: ../../LICENSE

package/dist/index.d.ts

@@ -0,0 +1,59 @@
+//#region src/meta.d.ts
+declare const meta: Readonly<{
+  name: string;
+  version: string;
+  buildNumber: number;
+}>;
+//#endregion
+//#region src/eslintIgnores.d.ts
+/**
+ * Create a new eslint configuration object
+ *
+ * @example
+ * ```ts
+ * // eslint.config.js
+ * export default [
+ *   await eslintIgnores({
+ *     ignores: [
+ *       // Add custom paths here
+ *     ]
+ *   })
+ * ];
+ * ```
+ *
+ * @param options
+ */
+declare function eslintIgnores(options?: ESLintIgnoreOptions): Promise<ESLintIgnoreConfig>;
+interface ESLintIgnoreConfig {
+  /**
+   * The configuration name
+   */
+  name: string;
+  /**
+   * The file globs to ignore
+   */
+  ignores: Array<string>;
+}
+interface ESLintIgnoreOptions {
+  /**
+   * Override configuration name
+   */
+  name?: ESLintIgnoreConfig['name'];
+  /**
+   * Override current working directory
+   */
+  cwd?: string;
+  /**
+   * Override or customize ignore patterns.
+   * - If passed an array, it appends patterns to the merged ignore list.
+   * - If passed a function, it receives the merged list and returns the final array.
+   */
+  ignores?: ESLintIgnoreConfig['ignores'] | ((ignores: ESLintIgnoreConfig['ignores']) => ESLintIgnoreConfig['ignores']);
+  /**
+   * Include recommended settings and default ignored files
+   */
+  recommended?: boolean | undefined;
+}
+//#endregion
+export { ESLintIgnoreConfig, ESLintIgnoreOptions, type ESLintIgnoreOptions as Options, eslintIgnores as default, eslintIgnores, meta };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,128 @@
+import fs from "node:fs";
+import nodePath from "node:path";
+import process from "node:process";
+import parseGitignore from "parse-gitignore";
+import { findUp } from "find-up";
+//#region src/meta.ts
+const meta = Object.freeze({
+	name: "@w5s/eslint-config-ignore",
+	version: "1.1.0",
+	buildNumber: 1
+});
+//#endregion
+//#region src/defaultIgnores.ts
+const defaultIgnores = [
+	"**/package-lock.json",
+	"**/yarn.lock",
+	"**/pnpm-lock.yaml",
+	"**/bun.lockb",
+	"**/output",
+	"**/.output",
+	"**/coverage",
+	"**/temp",
+	"**/.temp",
+	"**/tmp",
+	"**/.tmp",
+	"**/.cache",
+	"**/*.min.*",
+	"**/*.timestamp-*.mjs",
+	".go/",
+	".pnpm-store/",
+	"**/.vitepress/cache",
+	"**/.vite-inspect",
+	"**/.history",
+	"**/.nuxt",
+	"**/.next",
+	"**/.svelte-kit",
+	"**/.vercel",
+	"**/.idea",
+	"**/.yarn",
+	"**/__snapshots__/**",
+	".modules/",
+	"**/.context",
+	"**/.claude",
+	"**/.agents",
+	"**/.*/skills"
+];
+//#endregion
+//#region src/internal/ignoreFileParse.ts
+function ignoreFileParse(input) {
+	return parseGitignore.parse(input).patterns;
+}
+//#endregion
+//#region src/internal/ignoreFileFind.ts
+async function ignoreFileFind(cwd) {
+	return (await Promise.all([
+		findUp(nodePath.join("", ".gitignore"), { cwd }),
+		findUp(nodePath.join("android", ".gitignore"), { cwd }),
+		findUp(nodePath.join("ios", ".gitignore"), { cwd })
+	])).filter((filePath) => filePath !== void 0).map((filePath) => nodePath.relative(cwd, filePath));
+}
+//#endregion
+//#region src/internal/ignoreRuleResolve.ts
+/**
+* Resolve a raw ignore rule from a `.gitignore` file into a path
+* relative to the configured working directory.
+*
+* @example
+* ```ts
+* import { ignoreRuleResolve } from './internal/ignoreRuleResolve.js';
+*
+* ignoreRuleResolve('.', 'dist'); // 'dist'
+* ignoreRuleResolve('.', '/dist'); // 'dist'
+* ignoreRuleResolve('android', 'android-build'); // 'android/android-build'
+* ignoreRuleResolve('android', '!android-build'); // '!android/android-build'
+* ```
+*
+* @internal
+* @param prefix A path prefix that points to the directory containing the `.gitignore` file.
+* @param rule The raw ignore rule parsed from `.gitignore`.
+* @returns A normalized ignore pattern relative to the root `cwd`.
+*/
+function ignoreRuleResolve(prefix, rule) {
+	const negated = rule.startsWith("!");
+	const normalizedPattern = negated ? rule.slice(1) : rule;
+	const trimmedPattern = normalizedPattern.startsWith("/") ? normalizedPattern.slice(1) : normalizedPattern;
+	const relativeIgnorePath = nodePath.join(prefix, trimmedPattern);
+	return negated ? `!${relativeIgnorePath}` : relativeIgnorePath;
+}
+//#endregion
+//#region src/eslintIgnores.ts
+/**
+* Create a new eslint configuration object
+*
+* @example
+* ```ts
+* // eslint.config.js
+* export default [
+*   await eslintIgnores({
+*     ignores: [
+*       // Add custom paths here
+*     ]
+*   })
+* ];
+* ```
+*
+* @param options
+*/
+async function eslintIgnores(options = {}) {
+	const cwd = options.cwd ?? process.cwd();
+	const recommended = options.recommended ?? true;
+	const ignoreFilePaths = await ignoreFileFind(cwd);
+	const ignoreGlobs = await Promise.all(ignoreFilePaths.map(async (ignoreFilePathRelative) => {
+		const ignoreFilePath = nodePath.join(cwd, ignoreFilePathRelative);
+		const patterns = ignoreFileParse(String(await fs.promises.readFile(ignoreFilePath)));
+		const ignoreDirectoryRelative = nodePath.dirname(ignoreFilePathRelative);
+		return patterns.map((pattern) => ignoreRuleResolve(ignoreDirectoryRelative, pattern));
+	}));
+	const mergedIgnores = [...recommended ? defaultIgnores : [], ...ignoreGlobs.flat()];
+	const ignores = typeof options.ignores === "function" ? options.ignores(mergedIgnores) : options.ignores ? [...mergedIgnores, ...options.ignores] : mergedIgnores;
+	return {
+		name: options.name ?? "w5s/eslint-ignore",
+		ignores
+	};
+}
+//#endregion
+export { eslintIgnores as default, eslintIgnores, meta };
+
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/meta.ts","../src/defaultIgnores.ts","../src/internal/ignoreFileParse.ts","../src/internal/ignoreFileFind.ts","../src/internal/ignoreRuleResolve.ts","../src/eslintIgnores.ts"],"sourcesContent":["export const meta = Object.freeze({\n  // @ts-ignore - these variables are injected at build time\n  name: (typeof __PACKAGE_NAME__ === 'undefined' ? '' : __PACKAGE_NAME__) as string,\n  // @ts-ignore - these variables are injected at build time\n  version: (typeof __PACKAGE_VERSION__ === 'undefined' ? '' : __PACKAGE_VERSION__) as string,\n  // @ts-ignore - these variables are injected at build time\n  buildNumber: 1 as number, // (typeof __PACKAGE_BUILD_NUMBER__ === 'undefined' ? 0 : __PACKAGE_BUILD_NUMBER__) as number,\n});\n","export const defaultIgnores = [\n  // Lock files\n  '**/package-lock.json',\n  '**/yarn.lock',\n  '**/pnpm-lock.yaml',\n  '**/bun.lockb',\n\n  // Commonly ignored\n  '**/output',\n  '**/.output',\n  '**/coverage',\n  '**/temp',\n  '**/.temp',\n  '**/tmp',\n  '**/.tmp',\n  '**/.cache',\n\n  // Well known extensions to ignore\n  '**/*.min.*',\n  '**/*.timestamp-*.mjs',\n\n  // Framework specific temporary folder\n  '.go/',\n  '.pnpm-store/',\n  '**/.vitepress/cache',\n  '**/.vite-inspect',\n  '**/.history',\n  '**/.nuxt',\n  '**/.next',\n  '**/.svelte-kit',\n  '**/.vercel',\n  '**/.idea',\n  '**/.yarn',\n  '**/__snapshots__/**',\n\n  // git submodules (makefile-core / makefile-ci)\n  '.modules/',\n\n  // AI related\n  '**/.context',\n  '**/.claude',\n  '**/.agents',\n  '**/.*/skills',\n];\n","import parseGitignore from 'parse-gitignore';\n\nexport function ignoreFileParse(input: string): Array<string> {\n  return parseGitignore.parse(input).patterns;\n};\n","import nodePath from 'node:path';\nimport { findUp } from 'find-up';\n\nexport async function ignoreFileFind(cwd: string): Promise<Array<string>> {\n  const files = await Promise.all(\n    [\n      findUp(nodePath.join('', '.gitignore'), { cwd }),\n      // TODO: refactor as generic exploration\n      findUp(nodePath.join('android', '.gitignore'), { cwd }),\n      findUp(nodePath.join('ios', '.gitignore'), { cwd }),\n    ],\n  );\n\n  return files\n    .filter((filePath): filePath is string => filePath !== undefined)\n    .map((filePath) => nodePath.relative(cwd, filePath));\n}\n","import nodePath from 'node:path';\n\n/**\n * Resolve a raw ignore rule from a `.gitignore` file into a path\n * relative to the configured working directory.\n *\n * @example\n * ```ts\n * import { ignoreRuleResolve } from './internal/ignoreRuleResolve.js';\n *\n * ignoreRuleResolve('.', 'dist'); // 'dist'\n * ignoreRuleResolve('.', '/dist'); // 'dist'\n * ignoreRuleResolve('android', 'android-build'); // 'android/android-build'\n * ignoreRuleResolve('android', '!android-build'); // '!android/android-build'\n * ```\n *\n * @internal\n * @param prefix A path prefix that points to the directory containing the `.gitignore` file.\n * @param rule The raw ignore rule parsed from `.gitignore`.\n * @returns A normalized ignore pattern relative to the root `cwd`.\n */\nexport function ignoreRuleResolve(prefix: string, rule: string) {\n  const negated = rule.startsWith('!');\n  const normalizedPattern = negated ? rule.slice(1) : rule;\n  const trimmedPattern = normalizedPattern.startsWith('/')\n    ? normalizedPattern.slice(1)\n    : normalizedPattern;\n  const relativeIgnorePath = nodePath.join(prefix, trimmedPattern);\n\n  return negated ? `!${relativeIgnorePath}` : relativeIgnorePath;\n}\n","import fs from 'node:fs';\nimport nodePath from 'node:path';\nimport process from 'node:process';\nimport { defaultIgnores } from './defaultIgnores.js';\nimport { ignoreFileParse } from './internal/ignoreFileParse.js';\nimport { ignoreFileFind } from './internal/ignoreFileFind.js';\nimport { ignoreRuleResolve } from './internal/ignoreRuleResolve.js';\n\n/**\n * Create a new eslint configuration object\n *\n * @example\n * ```ts\n * // eslint.config.js\n * export default [\n *   await eslintIgnores({\n *     ignores: [\n *       // Add custom paths here\n *     ]\n *   })\n * ];\n * ```\n *\n * @param options\n */\nexport async function eslintIgnores(options: ESLintIgnoreOptions = {}): Promise<ESLintIgnoreConfig> {\n  const cwd = options.cwd ?? process.cwd();\n  const recommended = options.recommended ?? true;\n  const ignoreFilePaths = await ignoreFileFind(cwd);\n  const ignoreGlobs = (await Promise.all(ignoreFilePaths.map(async (ignoreFilePathRelative) => {\n    const ignoreFilePath = nodePath.join(cwd, ignoreFilePathRelative);\n    const ignoreFileContent = String(await fs.promises.readFile(ignoreFilePath));\n    const patterns = ignoreFileParse(ignoreFileContent);\n    const ignoreDirectoryRelative = nodePath.dirname(ignoreFilePathRelative);\n\n    return patterns.map((pattern) => ignoreRuleResolve(ignoreDirectoryRelative, pattern));\n  })));\n\n  const mergedIgnores = [\n    ...(recommended ? defaultIgnores : []),\n    ...ignoreGlobs.flat(),\n  ];\n\n  const ignores = typeof options.ignores === 'function'\n    ? options.ignores(mergedIgnores)\n    : options.ignores\n      ? [...mergedIgnores, ...options.ignores]\n      : mergedIgnores;\n\n  return {\n    name: options.name ?? 'w5s/eslint-ignore',\n    ignores,\n  };\n}\n\nexport interface ESLintIgnoreConfig {\n  /**\n   * The configuration name\n   */\n  name: string;\n\n  /**\n   * The file globs to ignore\n   */\n  ignores: Array<string>;\n}\n\nexport interface ESLintIgnoreOptions {\n  /**\n   * Override configuration name\n   */\n  name?: ESLintIgnoreConfig['name'];\n\n  /**\n   * Override current working directory\n   */\n  cwd?: string;\n\n  /**\n   * Override or customize ignore patterns.\n   * - If passed an array, it appends patterns to the merged ignore list.\n   * - If passed a function, it receives the merged list and returns the final array.\n   */\n  ignores?: ESLintIgnoreConfig['ignores'] | ((ignores: ESLintIgnoreConfig['ignores']) => ESLintIgnoreConfig['ignores']);\n\n  /**\n   * Include recommended settings and default ignored files\n   */\n  recommended?: boolean | undefined;\n}\n"],"mappings":";;;;;;AAAA,MAAa,OAAO,OAAO,OAAO;CAEhC,MAAA;CAEA,SAAA;CAEA,aAAa;AACf,CAAC;;;ACPD,MAAa,iBAAiB;CAE5B;CACA;CACA;CACA;CAGA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CACA;CAGA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CACA;CAGA;CAGA;CACA;CACA;CACA;AACF;;;ACzCA,SAAgB,gBAAgB,OAA8B;CAC5D,OAAO,eAAe,MAAM,KAAK,CAAC,CAAC;AACrC;;;ACDA,eAAsB,eAAe,KAAqC;CAUxE,QAAO,MATa,QAAQ,IAC1B;EACE,OAAO,SAAS,KAAK,IAAI,YAAY,GAAG,EAAE,IAAI,CAAC;EAE/C,OAAO,SAAS,KAAK,WAAW,YAAY,GAAG,EAAE,IAAI,CAAC;EACtD,OAAO,SAAS,KAAK,OAAO,YAAY,GAAG,EAAE,IAAI,CAAC;CACpD,CACF,EAAA,CAGG,QAAQ,aAAiC,aAAa,KAAA,CAAS,CAAC,CAChE,KAAK,aAAa,SAAS,SAAS,KAAK,QAAQ,CAAC;AACvD;;;;;;;;;;;;;;;;;;;;;;ACKA,SAAgB,kBAAkB,QAAgB,MAAc;CAC9D,MAAM,UAAU,KAAK,WAAW,GAAG;CACnC,MAAM,oBAAoB,UAAU,KAAK,MAAM,CAAC,IAAI;CACpD,MAAM,iBAAiB,kBAAkB,WAAW,GAAG,IACnD,kBAAkB,MAAM,CAAC,IACzB;CACJ,MAAM,qBAAqB,SAAS,KAAK,QAAQ,cAAc;CAE/D,OAAO,UAAU,IAAI,uBAAuB;AAC9C;;;;;;;;;;;;;;;;;;;;ACLA,eAAsB,cAAc,UAA+B,CAAC,GAAgC;CAClG,MAAM,MAAM,QAAQ,OAAO,QAAQ,IAAI;CACvC,MAAM,cAAc,QAAQ,eAAe;CAC3C,MAAM,kBAAkB,MAAM,eAAe,GAAG;CAChD,MAAM,cAAe,MAAM,QAAQ,IAAI,gBAAgB,IAAI,OAAO,2BAA2B;EAC3F,MAAM,iBAAiB,SAAS,KAAK,KAAK,sBAAsB;EAEhE,MAAM,WAAW,gBADS,OAAO,MAAM,GAAG,SAAS,SAAS,cAAc,CACzB,CAAC;EAClD,MAAM,0BAA0B,SAAS,QAAQ,sBAAsB;EAEvE,OAAO,SAAS,KAAK,YAAY,kBAAkB,yBAAyB,OAAO,CAAC;CACtF,CAAC,CAAC;CAEF,MAAM,gBAAgB,CACpB,GAAI,cAAc,iBAAiB,CAAC,GACpC,GAAG,YAAY,KAAK,CACtB;CAEA,MAAM,UAAU,OAAO,QAAQ,YAAY,aACvC,QAAQ,QAAQ,aAAa,IAC7B,QAAQ,UACN,CAAC,GAAG,eAAe,GAAG,QAAQ,OAAO,IACrC;CAEN,OAAO;EACL,MAAM,QAAQ,QAAQ;EACtB;CACF;AACF"}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@w5s/eslint-config-ignore",
+  "version": "1.1.0",
+  "description": "Shared ESLint ignore configuration generator",
+  "keywords": [
+    "eslint",
+    "config",
+    "ignore"
+  ],
+  "homepage": "https://github.com/w5s/project-config/blob/main/packages/eslint-config-ignore#readme",
+  "bugs": {
+    "url": "https://github.com/w5s/project-config/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh@github.com:w5s/project-config.git",
+    "directory": "packages/eslint-config-ignore"
+  },
+  "license": "MIT",
+  "author": "Julien Polo <julien.polo@gmail.com>",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./dist/*": "./dist/*"
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "index.js",
+    "index.d.ts",
+    "!*.d.ts.map",
+    "!**/*.spec.*",
+    "!**/__tests__/**"
+  ],
+  "scripts": {
+    "postpack": "clean-package restore"
+  },
+  "dependencies": {
+    "find-up": "^8.0.0",
+    "parse-gitignore": "^2.0.0"
+  },
+  "peerDependencies": {
+    "eslint": "9.x || 10.x",
+    "typescript": "4.x || 5.x || 6.x"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffect": false,
+  "gitHead": "fc447207d2af5368f809a9a90d0e4056344b812a"
+}

package/src/defaultIgnores.ts

@@ -0,0 +1,44 @@
+export const defaultIgnores = [
+  // Lock files
+  '**/package-lock.json',
+  '**/yarn.lock',
+  '**/pnpm-lock.yaml',
+  '**/bun.lockb',
+
+  // Commonly ignored
+  '**/output',
+  '**/.output',
+  '**/coverage',
+  '**/temp',
+  '**/.temp',
+  '**/tmp',
+  '**/.tmp',
+  '**/.cache',
+
+  // Well known extensions to ignore
+  '**/*.min.*',
+  '**/*.timestamp-*.mjs',
+
+  // Framework specific temporary folder
+  '.go/',
+  '.pnpm-store/',
+  '**/.vitepress/cache',
+  '**/.vite-inspect',
+  '**/.history',
+  '**/.nuxt',
+  '**/.next',
+  '**/.svelte-kit',
+  '**/.vercel',
+  '**/.idea',
+  '**/.yarn',
+  '**/__snapshots__/**',
+
+  // git submodules (makefile-core / makefile-ci)
+  '.modules/',
+
+  // AI related
+  '**/.context',
+  '**/.claude',
+  '**/.agents',
+  '**/.*/skills',
+];

package/src/eslintIgnores.ts

@@ -0,0 +1,90 @@
+import fs from 'node:fs';
+import nodePath from 'node:path';
+import process from 'node:process';
+import { defaultIgnores } from './defaultIgnores.js';
+import { ignoreFileParse } from './internal/ignoreFileParse.js';
+import { ignoreFileFind } from './internal/ignoreFileFind.js';
+import { ignoreRuleResolve } from './internal/ignoreRuleResolve.js';
+
+/**
+ * Create a new eslint configuration object
+ *
+ * @example
+ * ```ts
+ * // eslint.config.js
+ * export default [
+ *   await eslintIgnores({
+ *     ignores: [
+ *       // Add custom paths here
+ *     ]
+ *   })
+ * ];
+ * ```
+ *
+ * @param options
+ */
+export async function eslintIgnores(options: ESLintIgnoreOptions = {}): Promise<ESLintIgnoreConfig> {
+  const cwd = options.cwd ?? process.cwd();
+  const recommended = options.recommended ?? true;
+  const ignoreFilePaths = await ignoreFileFind(cwd);
+  const ignoreGlobs = (await Promise.all(ignoreFilePaths.map(async (ignoreFilePathRelative) => {
+    const ignoreFilePath = nodePath.join(cwd, ignoreFilePathRelative);
+    const ignoreFileContent = String(await fs.promises.readFile(ignoreFilePath));
+    const patterns = ignoreFileParse(ignoreFileContent);
+    const ignoreDirectoryRelative = nodePath.dirname(ignoreFilePathRelative);
+
+    return patterns.map((pattern) => ignoreRuleResolve(ignoreDirectoryRelative, pattern));
+  })));
+
+  const mergedIgnores = [
+    ...(recommended ? defaultIgnores : []),
+    ...ignoreGlobs.flat(),
+  ];
+
+  const ignores = typeof options.ignores === 'function'
+    ? options.ignores(mergedIgnores)
+    : options.ignores
+      ? [...mergedIgnores, ...options.ignores]
+      : mergedIgnores;
+
+  return {
+    name: options.name ?? 'w5s/eslint-ignore',
+    ignores,
+  };
+}
+
+export interface ESLintIgnoreConfig {
+  /**
+   * The configuration name
+   */
+  name: string;
+
+  /**
+   * The file globs to ignore
+   */
+  ignores: Array<string>;
+}
+
+export interface ESLintIgnoreOptions {
+  /**
+   * Override configuration name
+   */
+  name?: ESLintIgnoreConfig['name'];
+
+  /**
+   * Override current working directory
+   */
+  cwd?: string;
+
+  /**
+   * Override or customize ignore patterns.
+   * - If passed an array, it appends patterns to the merged ignore list.
+   * - If passed a function, it receives the merged list and returns the final array.
+   */
+  ignores?: ESLintIgnoreConfig['ignores'] | ((ignores: ESLintIgnoreConfig['ignores']) => ESLintIgnoreConfig['ignores']);
+
+  /**
+   * Include recommended settings and default ignored files
+   */
+  recommended?: boolean | undefined;
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './meta.js';
+export * from './eslintIgnores.js';
+export type { ESLintIgnoreOptions as Options } from './eslintIgnores.js';
+export { eslintIgnores as default } from './eslintIgnores.js';

package/src/internal/ignoreFileFind.ts

@@ -0,0 +1,17 @@
+import nodePath from 'node:path';
+import { findUp } from 'find-up';
+
+export async function ignoreFileFind(cwd: string): Promise<Array<string>> {
+  const files = await Promise.all(
+    [
+      findUp(nodePath.join('', '.gitignore'), { cwd }),
+      // TODO: refactor as generic exploration
+      findUp(nodePath.join('android', '.gitignore'), { cwd }),
+      findUp(nodePath.join('ios', '.gitignore'), { cwd }),
+    ],
+  );
+
+  return files
+    .filter((filePath): filePath is string => filePath !== undefined)
+    .map((filePath) => nodePath.relative(cwd, filePath));
+}

package/src/internal/ignoreFileParse.ts

@@ -0,0 +1,5 @@
+import parseGitignore from 'parse-gitignore';
+
+export function ignoreFileParse(input: string): Array<string> {
+  return parseGitignore.parse(input).patterns;
+};

package/src/internal/ignoreRuleResolve.ts

@@ -0,0 +1,31 @@
+import nodePath from 'node:path';
+
+/**
+ * Resolve a raw ignore rule from a `.gitignore` file into a path
+ * relative to the configured working directory.
+ *
+ * @example
+ * ```ts
+ * import { ignoreRuleResolve } from './internal/ignoreRuleResolve.js';
+ *
+ * ignoreRuleResolve('.', 'dist'); // 'dist'
+ * ignoreRuleResolve('.', '/dist'); // 'dist'
+ * ignoreRuleResolve('android', 'android-build'); // 'android/android-build'
+ * ignoreRuleResolve('android', '!android-build'); // '!android/android-build'
+ * ```
+ *
+ * @internal
+ * @param prefix A path prefix that points to the directory containing the `.gitignore` file.
+ * @param rule The raw ignore rule parsed from `.gitignore`.
+ * @returns A normalized ignore pattern relative to the root `cwd`.
+ */
+export function ignoreRuleResolve(prefix: string, rule: string) {
+  const negated = rule.startsWith('!');
+  const normalizedPattern = negated ? rule.slice(1) : rule;
+  const trimmedPattern = normalizedPattern.startsWith('/')
+    ? normalizedPattern.slice(1)
+    : normalizedPattern;
+  const relativeIgnorePath = nodePath.join(prefix, trimmedPattern);
+
+  return negated ? `!${relativeIgnorePath}` : relativeIgnorePath;
+}

package/src/meta.ts

@@ -0,0 +1,8 @@
+export const meta = Object.freeze({
+  // @ts-ignore - these variables are injected at build time
+  name: (typeof __PACKAGE_NAME__ === 'undefined' ? '' : __PACKAGE_NAME__) as string,
+  // @ts-ignore - these variables are injected at build time
+  version: (typeof __PACKAGE_VERSION__ === 'undefined' ? '' : __PACKAGE_VERSION__) as string,
+  // @ts-ignore - these variables are injected at build time
+  buildNumber: 1 as number, // (typeof __PACKAGE_BUILD_NUMBER__ === 'undefined' ? 0 : __PACKAGE_BUILD_NUMBER__) as number,
+});