feat: allow load npm module as extends

intuit · Mar 7, 2022 · 04e679c · 04e679c
1 parent 8fd6684
commit 04e679c
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 3 deletions.
diff --git a/docs/pages/docs/configuration/autorc.mdx b/docs/pages/docs/configuration/autorc.mdx
@@ -411,15 +411,15 @@ Auto can load `extends` configs in the following ways:
 }
 ```
 
-Will use the package `@YOUR_SCOPE/auto-config`
+Will use the package `@YOUR_SCOPE/auto-config` (the `auto` key in `package.json` file)
 
 ```json
 {
   "extends": "joe"
 }
 ```
 
-Will use the package `auto-config-joe`
+Will use the package `auto-config-joe` (the `auto` key in `package.json` file)
 
 > :warning: If extending from a config package make sure it's a dependency of your project
 

diff --git a/packages/core/src/__tests__/config.test.ts b/packages/core/src/__tests__/config.test.ts
@@ -14,7 +14,9 @@ beforeEach(() => {
 const log = dummyLog();
 
 const importMock = jest.fn();
-jest.mock("import-cwd", () => (path: string) => importMock(path));
+jest.mock("import-cwd", () => {
+  return (path: any) => importMock(path);
+});
 
 describe("normalizeLabel", () => {
   test("should extend base label", () => {
@@ -149,4 +151,19 @@ describe("loadExtendConfig", () => {
       noVersionPrefix: true,
     });
   });
+
+  test("should load an npm module", async () => {
+    const config = new Config(log);
+
+    importMock.mockImplementation((path) =>
+        path === "auto-config-from-module"
+            ? { noVersionPrefix: true }
+            : undefined
+    );
+
+    expect(await config.loadExtendConfig("auto-config-from-module")).toStrictEqual({
+      extends: "auto-config-from-module",
+      noVersionPrefix: true,
+    });
+  });
 });
diff --git a/packages/core/src/config.ts b/packages/core/src/config.ts
@@ -201,6 +201,11 @@ export default class Config {
       }
     }
 
+    if (!config) {
+      config = tryRequire(extend);
+      this.logger.verbose.note(`${extend} found: ${config}`);
+    }
+
     if (!config) {
       throw new Error(`Unable to load extended config ${extend}`);
     }