![\"npm](\"https://img.shields.io/npm/v/@alexey-gara/ag-eslint-ts\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/@alexey-gara/ag-eslint-ts\")
\n \n \n ![\"license\"](\"https://img.shields.io/github/license/AlexeyGara/ag-eslint-ts\")
\n \n\n Shared ESLint & TypeScript configuration for streamlined development.\n
\n\n\n\n---\n\n## Features\n\n- ✅ Preconfigured **ESLint** rules\n- ✅ Ready-to-use **TypeScript** setup\n- ✅ Integrated **Prettier**\n- ✅ Supports **Flat Config (ESLint v9+)**\n- ✅ Backward compatibility with **ESLint v8**\n- ✅ Works with `pnpm` monorepos\n\n[🔗 Explore ESLint configuration and rules](https://alexeygara.github.io/ag-eslint-ts/)\n\n---\n\n## Installation\n\n> [!TIP]\n> Recommended for **ESLint v9+ (Flat Config)** and **TypeScript v5+**:\n\n```bash\npnpm add -D @alexey-gara/ag-eslint-ts eslint typescript prettier\n```\n\nFor older IDEs that do **not support ESLint v9+ (Flat Config)** and/or **TypeScript v5+** \n_(e.g., IDEA 2022.2 and earlier)_:\n\n```bash\npnpm add -D @alexey-gara/ag-eslint-ts eslint@8.57.1 typescript@4.9.5 prettier@3.5.3\n```\n\n---\n\n## Usage\n\n### ESLint Setup\n\n#### Modern (Flat Config, ESLint v9+)\n\nCreate `eslint.config.mjs` in the root of your project (next to `project.json`):\n\n```js\nimport agConfig from '@alexey-gara/ag-eslint-ts';\n\nexport default [\n ...agConfig,\n {\n rules: {\n // your custom rules here\n }\n }\n];\n```\n\n---\n\n#### Legacy (ESLint v8)\n\nFor older IDEs without Flat Config support:\n\nCreate `.eslintrc.cjs`:\n\n```js\nmodule.exports = {\n extends: [\n require.resolve('@alexey-gara/ag-eslint-ts')\n ],\n parserOptions: {\n tsconfigRootDir: __dirname,\n },\n root: true,\n rules: {\n // your custom rules here\n }\n};\n```\n\n---\n\n### pnpm Compatibility\n\nBefore installing dependencies, create a `.npmrc` file in your project root:\n\n```ini\npublic-hoist-pattern[]=*eslint*\npublic-hoist-pattern[]=*prettier*\n```\n\n> [!NOTE]\n> `pnpm` stores dependencies (like `eslint-plugin-import`) inside a virtual store. \n> This configuration ensures ESLint can properly resolve plugins.\n\n---\n\n### TypeScript Setup\n\nExtend your `tsconfig.json`:\n\n```json\n{\n \"extends\": \"@alexey-gara/ag-eslint-ts/tsconfig.json\",\n \"compilerOptions\": {\n // your project's TypeScript compiler options\n },\n \"include\": [\n // files to include\n ],\n \"exclude\": [\n // files and folders to exclude\n ]\n}\n```\n\n---\n\n## Example\n\nMinimal project setup:\n\n```bash\npnpm add -D @alexey-gara/ag-eslint-ts eslint typescript prettier\n```\n\n`eslint.config.mjs`:\n\n```js\nimport agConfig from '@alexey-gara/ag-eslint-ts';\n\nexport default agConfig;\n```\n\n---\n\n## FAQ\n\n### Why do I need `.npmrc`?\n\nBecause `pnpm` isolates dependencies. \nWithout hoisting, ESLint may fail to find plugins like `eslint-plugin-import`.\n\n---\n\n### Does this work with monorepos?\n\nYes. \nThis config is designed to work well with `pnpm` workspaces and monorepos.\n\n---\n\n### Can I override rules?\n\nAbsolutely:\n\n```js\nexport default [\n ...agConfig,\n {\n rules: {\n 'no-console': 'warn'\n }\n }\n];\n```\n\n---\n\n### Do I need Prettier separately?\n\nYes — Prettier is included in the setup but must still be installed as a dependency.\n\n---\n\n## License\n\n[MIT](https://github.com/AlexeyGara/ag-eslint-ts/blob/main/LICENSE)\n\n---\n\n## ESLint Rules Overview\n\nThis configuration extends multiple rule sets and plugins and is based on:\n- `typescript-eslint` recommended rules\n- `eslint-plugin-import`\n- `@stylistic/eslint-plugin-ts`\n+ full list of rules are here [.eslint-rules.json](https://github.com/AlexeyGara/ag-eslint-ts/blob/main/.eslint-rules.json)\n+ inspect all rules - [https://alexeygara.github.io/ag-eslint-ts/rules](https://alexeygara.github.io/ag-eslint-ts/rules)\n\nTo see the full resolved list of rules used in your project, run:\n\n```bash\nnpx eslint --print-config index.ts\n```\n\n> Replace `index.ts` with any file from your project.\n\n## TypeScript Configuration Overview\n\nThis package provides a base `tsconfig.json` with strict and modern TypeScript setup.\n\n### Target & Environment\n\n- `target`: `ES2020`\n- `module`: `ESNext`\n- `lib`: `ES2020`, `DOM`, `DOM.Iterable`\n- `moduleResolution`: `node`\n\n---\n\n### Core Features\n\n- Decorators enabled:\n - `experimentalDecorators`\n - `emitDecoratorMetadata`\n\n- Optimized for bundlers:\n - `isolatedModules`\n - `moduleDetection: \"force\"`\n - `noEmit: true`\n\n---\n\n### Strictness\n\nStrict mode is fully enabled:\n\n- `strict`\n- `strictNullChecks`\n- `strictFunctionTypes`\n- `strictBindCallApply`\n- `strictPropertyInitialization`\n\n---\n\n### Safety Rules\n\n- `noImplicitAny`\n- `noImplicitThis`\n- `noImplicitReturns`\n- `noImplicitOverride`\n\n---\n\n### Code Quality\n\n- `noUnusedLocals`\n- `noUnusedParameters`\n- `noFallthroughCasesInSwitch`\n- `noPropertyAccessFromIndexSignature`\n\n---\n\n### Trade-offs / Relaxed Rules\n\nThese are intentionally less strict for better DX:\n\n- `useUnknownInCatchVariables: false`\n- `noUncheckedIndexedAccess: false`\n- `exactOptionalPropertyTypes: false`\n\n---\n\nTo inspect the fully resolved configuration, run:\n\n```bash\nnpx tsc --showConfig\n```\n","readmeFilename":"README.md","homepage":"https://github.com/AlexeyGara/ag-eslint-ts#readme","repository":{"type":"git","url":"git+https://github.com/AlexeyGara/ag-eslint-ts.git"},"bugs":{"url":"https://github.com/AlexeyGara/ag-eslint-ts/issues"}}