Merge pull request #37 from n1ru4l/named-export

replace default export with a named export

Author: Codex-

.eslintrc.json

@@ -9,7 +9,8 @@
     "esbuild.config.mjs",
     "jest.config.ts",
     "coverage",
-    "dist"
+    "dist",
+    "smoke-tests"
   ],
   "rules": {
     "@typescript-eslint/await-thenable": "warn",

.github/workflows/build.yml

@@ -30,6 +30,15 @@ jobs:
         id: test
         if: ${{ always() }}
         run: npm run test
+      - name: Import with CJS
+        if: ${{ always() }}
+        run: node smoke-tests/smoke-test-cjs.js
+      - name: Import with ESM
+        if: ${{ always() }}
+        run: node smoke-tests/smoke-test-esm.mjs
+      - name: Import with both CJS and ESM
+        if: ${{ always() }}
+        run: node smoke-tests/smoke-test.js
       - name: lint
         if: ${{ always() }}
         run: npm run lint

README.md

@@ -22,7 +22,7 @@ Simply add `TypeScriptLoader` to the list of loaders for the `.ts` file type:
 
 ```ts
 import { cosmiconfig } from "cosmiconfig";
-import TypeScriptLoader from "cosmiconfig-typescript-loader";
+import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 
 const moduleName = "module";
 const explorer = cosmiconfig("test", {
@@ -51,7 +51,7 @@ Or more simply if you only support loading of a TypeScript based configuration f
 
 ```ts
 import { cosmiconfig } from "cosmiconfig";
-import TypeScriptLoader from "cosmiconfig-typescript-loader";
+import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 
 const moduleName = "module";
 const explorer = cosmiconfig("test", {

lib/index.spec.ts

@@ -1,6 +1,6 @@
 import path from "path";
 import { cosmiconfig, cosmiconfigSync } from "cosmiconfig";
-import TypeScriptLoader from ".";
+import { TypeScriptLoader } from ".";
 
 describe("TypeScriptLoader", () => {
   const fixturesPath = path.resolve(__dirname, "__fixtures__");

lib/index.ts

@@ -1,4 +1,2 @@
-import { TypeScriptLoader } from "./loader";
-
-export default TypeScriptLoader;
+export { TypeScriptLoader } from "./loader";
 export type { TypeScriptCompileError } from "./typescript-compile-error";

smoke-tests/smoke-test-cjs.js

@@ -0,0 +1,5 @@
+const mod = require("../dist/cjs/index.js");
+const { TypeScriptLoader } = mod;
+TypeScriptLoader();
+
+console.info("Loaded with CJS successfully");

smoke-tests/smoke-test-esm.mjs

@@ -0,0 +1,5 @@
+import mod from "../dist/cjs/index.js";
+const { TypeScriptLoader } = mod;
+TypeScriptLoader();
+
+console.info("Loaded with ESM successfully");

smoke-tests/smoke-test.js

@@ -0,0 +1,26 @@
+const assert = require("node:assert");
+
+(async () => {
+  try {
+    const esm = await import("../dist/cjs/index.js");
+    const cjs = require("../dist/cjs/index.js");
+
+    assert.strictEqual(
+      esm.TypeScriptLoader,
+      cjs.TypeScriptLoader,
+      "esm.TypeScriptLoader === cjs.TypeScriptLoader"
+    );
+
+    // try to create loaders
+    esm.TypeScriptLoader();
+    cjs.TypeScriptLoader();
+
+    console.info("Loaded with both CJS and ESM successfully");
+  } catch (error) {
+    console.error(error);
+    console.debug(error.stack);
+
+    // Prevent an unhandled rejection, exit gracefully.
+    process.exit(1);
+  }
+})();