feat: ✨ enable auto detection by default

BREAKING CHANGE: 💥 `autoDetect` is now `true` by default

README.md

@@ -8,8 +8,6 @@
 
 > 🔍 another opinionated [eslint](https://eslint.org) config
 
-_This is an evolution of [eslint-config-jimmy-guzman](https://github.com/jimmy-guzman/eslint-config-jimmy-guzman)_
-
 ## 🛠️ Usage
 
 _For a better experience, make sure to use [@jimmy.codes/prettier-config](https://github.com/jimmy-guzman/prettier-config) as well_
@@ -42,41 +40,43 @@ And if you're using [VS Code](https://code.visualstudio.com), make sure to enabl
 
 ### 🔧 Configuration
 
+**By default all rules are enabled based on the project's dependencies.**
+
 This package contains rules that can be enabled or disabled as follows:
 
 ```js
 import jimmyDotCodes from "@jimmy.codes/eslint-config";
 
 export default jimmyDotCodes({
   /**
-   * Are TypeScript rules are enabled?
+   * Are TypeScript rules enabled?
    * @default false
    */
   typescript: true,
   /**
-   * Are React rules are enabled?
+   * Are React rules enabled?
    * @default false
    */
   react: true,
   /**
-   * Are Astro rules are enabled?
+   * Are Astro rules enabled?
    * @default false
    */
   astro: true,
   /**
-   * Are testing rules are enabled?
+   * Are testing rules enabled?
    * @default false
    */
   testing: true,
 });
 ```
 
-Or you can enable auto detection to enable rules based on a project's dependencies
+Or you can turn off auto detection to enable rules based on a project's dependencies
 
 ```js
 import jimmyDotCodes from "@jimmy.codes/eslint-config";
 
-export default jimmyDotCodes({ autoDetect: true });
+export default jimmyDotCodes({ autoDetect: false });
 ```
 
 #### TypeScript
@@ -122,7 +122,7 @@ export default jimmyDotCodes({
 });
 ```
 
-#### Overrides
+#### Extending the Configuration
 
 You can also extend the configuration:
 

eslint.config.ts

@@ -1,3 +1,3 @@
 import jimmyDotCodes from "./src";
 
-export default jimmyDotCodes({ autoDetect: true });
+export default jimmyDotCodes();

scripts/typegen.ts

@@ -15,7 +15,7 @@ const ruleDts = await flatConfigsToRulesDTS(
       },
     },
     // @ts-expect-error TODO: config types don't seem to match
-    ...config({ autoDetect: true }),
+    ...config(),
   ],
   {
     includeAugmentation: false,

src/configs/react.spec.ts

@@ -2,7 +2,9 @@ import reactConfig from "./react";
 
 describe("reactConfig", () => {
   it("should create config w/ @tanstack/query rules", () => {
-    expect(reactConfig({ utilities: ["@tanstack/query"] })).toStrictEqual(
+    expect(
+      reactConfig({ utilities: ["@tanstack/query"] }, false),
+    ).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({
           name: "jimmy.codes/react/query",

src/configs/react.ts

@@ -13,7 +13,7 @@ import { type ReactOptions, type TypedConfigItem } from "../types";
 
 const reactConfig = (
   { utilities = [] }: ReactOptions = {},
-  autoDetect = false,
+  autoDetect = true,
 ) => {
   const includeReactQuery =
     utilities.includes("@tanstack/query") || (autoDetect && hasReactQuery());

src/configs/testing.spec.ts

@@ -3,7 +3,7 @@ import testingConfig from "./testing";
 
 describe("testingConfig", () => {
   it("should create default config w/ vitest overrides", () => {
-    const [, vitest] = testingConfig();
+    const [, vitest] = testingConfig({}, false);
 
     expect(vitest?.rules).toStrictEqual(
       expect.objectContaining({
@@ -19,7 +19,7 @@ describe("testingConfig", () => {
   });
 
   it("should create default config w/o vitest overrides", () => {
-    const [, jest] = testingConfig({ framework: "jest" });
+    const [, jest] = testingConfig({ framework: "jest" }, false);
 
     expect(jest?.rules).toStrictEqual(
       expect.not.objectContaining({

src/configs/testing.ts

@@ -8,7 +8,7 @@ import testingLibraryConfig from "./testing-library";
 
 const testingConfig = (
   { framework = "vitest", utilities }: TestingOptions = {},
-  autoDetect = false,
+  autoDetect = true,
 ) => {
   const isVitest = autoDetect ? hasVitest() : framework === "vitest";
   const isJest = framework === "jest" || (autoDetect && hasJest());

src/factory.spec.ts

@@ -6,7 +6,9 @@ vi.mock("local-pkg");
 
 describe("jimmyDotCodes", () => {
   it("should create configuration w/ typescript", () => {
-    expect(jimmyDotCodes({ typescript: true })).toStrictEqual(
+    expect(
+      jimmyDotCodes({ typescript: true, autoDetect: false }),
+    ).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: "jimmy.codes/typescript" }),
         expect.objectContaining({ name: "jimmy.codes/imports/typescript" }),
@@ -15,7 +17,7 @@ describe("jimmyDotCodes", () => {
   });
 
   it("should create configuration w/ react", () => {
-    expect(jimmyDotCodes({ react: true })).toStrictEqual(
+    expect(jimmyDotCodes({ react: true, autoDetect: false })).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: "jimmy.codes/react" }),
       ]),
@@ -24,7 +26,10 @@ describe("jimmyDotCodes", () => {
 
   it("should create configuration w/ react & @tanstack/query", () => {
     expect(
-      jimmyDotCodes({ react: { utilities: ["@tanstack/query"] } }),
+      jimmyDotCodes({
+        react: { utilities: ["@tanstack/query"] },
+        autoDetect: false,
+      }),
     ).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: "jimmy.codes/react" }),
@@ -34,7 +39,9 @@ describe("jimmyDotCodes", () => {
   });
 
   it("should create configuration w/ jest", () => {
-    expect(jimmyDotCodes({ testing: { framework: "jest" } })).toStrictEqual(
+    expect(
+      jimmyDotCodes({ testing: { framework: "jest" }, autoDetect: false }),
+    ).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
@@ -45,7 +52,7 @@ describe("jimmyDotCodes", () => {
   });
 
   it("should create configuration w/ vitest", () => {
-    expect(jimmyDotCodes({ testing: true })).toStrictEqual(
+    expect(jimmyDotCodes({ testing: true, autoDetect: false })).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({ name: "jimmy.codes/testing" }),
         expect.objectContaining({ name: "jimmy.codes/testing/disabled" }),
@@ -60,6 +67,7 @@ describe("jimmyDotCodes", () => {
       jimmyDotCodes({
         react: true,
         testing: { framework: "jest", utilities: ["testing-library"] },
+        autoDetect: false,
       }),
     ).toStrictEqual(
       expect.arrayContaining([
@@ -82,6 +90,7 @@ describe("jimmyDotCodes", () => {
       jimmyDotCodes({
         react: true,
         testing: { utilities: ["testing-library"] },
+        autoDetect: false,
       }),
     ).toStrictEqual(
       expect.arrayContaining([
@@ -100,7 +109,7 @@ describe("jimmyDotCodes", () => {
   });
 
   it("should create configuration w/ astro", () => {
-    expect(jimmyDotCodes({ astro: true })).toStrictEqual(
+    expect(jimmyDotCodes({ astro: true, autoDetect: false })).toStrictEqual(
       expect.arrayContaining([
         expect.objectContaining({
           name: "jimmy.codes/astro",

src/factory.ts

@@ -23,7 +23,7 @@ export const jimmyDotCodes = (
     react = false,
     testing = false,
     astro = false,
-    autoDetect = false,
+    autoDetect = true,
     configs = [],
   }: Options = {},
   ...moreConfigs: TypedConfigItem[] | Linter.Config[]

src/types.ts

@@ -51,26 +51,26 @@ export type TypedConfigItem = Omit<
 
 export interface Options {
   /**
-   * Are TypeScript rules are enabled?
+   * Are TypeScript rules enabled?
    * @default false
    */
   typescript?: boolean | TypescriptOptions;
   /**
-   * Are React rules are enabled?
+   * Are React rules enabled?
    * @default false
    */
   react?: boolean | ReactOptions;
   /**
-   * Are Jest rules are enabled?
+   * Are Jest rules enabled?
    * @default false
    */
   /**
-   * Are testing rules are enabled?
+   * Are testing rules enabled?
    * @default false
    */
   testing?: boolean | TestingOptions;
   /**
-   * Are astro rules are enabled?
+   * Are astro rules enabled?
    * @default false
    */
   astro?: boolean;
@@ -81,7 +81,7 @@ export interface Options {
   configs?: TypedConfigItem[] | Linter.Config[];
   /**
    * Is auto detection enabled?
-   * @default false
+   * @default true
    */
   autoDetect?: boolean;
 }