feat: ✨ drop all deprecated options, now simpler

README.md

@@ -6,7 +6,7 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://semantic-release.gitbook.io/semantic-release)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square&logo=prettier)](https://github.com/prettier/prettier)
 
-> 🔍 another opinionated [eslint](https://eslint.org) config
+> 🔍 Another opinionated [ESLint](https://eslint.org) config
 
 ## 🛠️ Usage
 
@@ -15,25 +15,33 @@
 
 ### 🔨 Getting Started
 
-First install the package, by running the following:
+First, install the package:
 
 ```
 pnpm add -D @jimmy.codes/eslint-config
 ```
 
-Then all you need to in your `eslint.config.js` is:
+Then, in your `eslint.config.js`, simply add:
 
 ```mjs
 import eslintConfig from "@jimmy.codes/eslint-config";
 
 export default eslintConfig();
 ```
 
-Which will enable rules based on your project dependencies.
+This automatically applies rules based on your installed dependencies.
 
 ### 🔧 Configuration
 
-This package contains rules that can be enabled or disabled as follows:
+By default, this config automatically enables rules based on your installed dependencies (e.g., `react`, `vitest`). Set `autoDetect: false` to disable this behavior.
+
+```ts
+import eslintConfig from "@jimmy.codes/eslint-config";
+
+export default eslintConfig({ autoDetect: false });
+```
+
+You can also manually enable or disable specific rule sets:
 
 ```ts
 import eslintConfig from "@jimmy.codes/eslint-config";
@@ -52,17 +60,9 @@ export default eslintConfig({
 });
 ```
 
-Or you can turn off auto detection to disable rules based on a project's dependencies:
+#### Extending/Overriding the Configuration
 
-```ts
-import eslintConfig from "@jimmy.codes/eslint-config";
-
-export default eslintConfig({ autoDetect: false });
-```
-
-#### Extending/overriding the Configuration
-
-You can also extend or override the configuration:
+You can extend or override the configuration using the `overrides` option:
 
 ```ts
 import eslintConfig from "@jimmy.codes/eslint-config";
@@ -85,7 +85,7 @@ export default eslintConfig({
 });
 ```
 
-Or pass configs as additional arguments:
+Alternatively, you can pass additional configurations as separate arguments:
 
 ```ts
 import eslintConfig from "@jimmy.codes/eslint-config";
@@ -107,7 +107,9 @@ export default eslintConfig(
 );
 ```
 
-#### Ignores
+> This approach is useful if you prefer to separate rule overrides into multiple objects instead of nesting them inside `overrides`.
+
+#### Ignoring Files
 
 You can also extend what is ignored:
 

scripts/typegen.ts

@@ -6,10 +6,7 @@ import { builtinRules } from "eslint/use-at-your-own-risk";
 import eslintConfig from "../src";
 
 const configs = await eslintConfig({
-  testing: {
-    // TODO: remove when framework approach is removed
-    framework: "jest",
-  },
+  jest: true,
 });
 
 const ruleDts = await flatConfigsToRulesDTS(

src/configs/__snapshots__/typescript.spec.ts.snap

@@ -9201,7 +9201,7 @@ If your function does not access \`this\`, you can annotate it with \`this: void
   {
     "languageOptions": {
       "parserOptions": {
-        "project": "/",
+        "projectService": true,
         "tsconfigRootDir": "/",
       },
     },

src/configs/imports.ts

@@ -2,7 +2,7 @@ import { createTypeScriptImportResolver } from "eslint-import-resolver-typescrip
 import importX from "eslint-plugin-import-x";
 import nodePlugin from "eslint-plugin-n";
 
-import type { TypedConfigItem, TypescriptOptions } from "../types";
+import type { TypedConfigItem } from "../types";
 
 import { importsRules } from "../rules/imports";
 
@@ -29,7 +29,7 @@ const importsTypescriptConfig = () => {
 };
 
 interface ImportsConfigOptions {
-  typescript?: boolean | TypescriptOptions;
+  typescript?: boolean;
 }
 
 export const importsConfig = ({

src/configs/jest.ts

@@ -0,0 +1,19 @@
+import type { TypedConfigItem } from "../types";
+
+import { GLOB_E2E, GLOB_TESTS } from "../constants";
+import { jestRules } from "../rules/jest";
+import { interopDefault } from "../utils/interop-default";
+
+export const jestConfig = async () => {
+  const jestPlugin = await interopDefault(import("eslint-plugin-jest"));
+
+  return [
+    {
+      files: GLOB_TESTS,
+      ignores: GLOB_E2E,
+      ...jestPlugin.configs["flat/recommended"],
+      name: "jimmy.codes/jest",
+      rules: await jestRules(),
+    },
+  ] satisfies TypedConfigItem[];
+};

src/configs/typescript.spec.ts

@@ -4,7 +4,7 @@ describe("typescriptConfig", () => {
   it("should create config", () => {
     vi.spyOn(process, "cwd").mockReturnValue("/");
 
-    expect(typescriptConfig({ project: "/" })).toMatchSnapshot();
+    expect(typescriptConfig()).toMatchSnapshot();
   });
 
   it("should create config w/ projectService", () => {

src/configs/typescript.ts

@@ -1,11 +1,9 @@
 import { configs } from "typescript-eslint";
 
-import type { TypescriptOptions } from "../types";
-
 import { GLOB_JS, GLOB_JSX, GLOB_TESTS } from "../constants";
 import { typescriptRules } from "../rules/typescript";
 
-export const typescriptConfig = (options?: TypescriptOptions) => {
+export const typescriptConfig = () => {
   return [
     ...configs.strictTypeChecked,
     ...configs.stylisticTypeChecked.filter((config) => {
@@ -14,9 +12,7 @@ export const typescriptConfig = (options?: TypescriptOptions) => {
     {
       languageOptions: {
         parserOptions: {
-          ...(options?.project
-            ? { project: options.project }
-            : { projectService: true }),
+          projectService: true,
           tsconfigRootDir: process.cwd(),
         },
       },

src/configs/vitest.ts

@@ -0,0 +1,19 @@
+import type { TypedConfigItem } from "../types";
+
+import { GLOB_E2E, GLOB_TESTS } from "../constants";
+import { vitestRules } from "../rules/vitest";
+import { interopDefault } from "../utils/interop-default";
+
+export const vitestConfig = async () => {
+  const vitestPlugin = await interopDefault(import("@vitest/eslint-plugin"));
+
+  return [
+    {
+      files: GLOB_TESTS,
+      ignores: GLOB_E2E,
+      ...vitestPlugin.configs.recommended,
+      name: "jimmy.codes/vitest",
+      rules: await vitestRules(),
+    },
+  ] satisfies TypedConfigItem[];
+};