feat: package is now ESM

octokit · Mar 7, 2024 · 8654409 · 8654409
1 parent 7c4f757
commit 8654409
Show file tree

Hide file tree

Showing 7 changed files with 69 additions and 62 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,14 +3,15 @@
   "publishConfig": {
     "access": "public"
   },
+  "type": "module",
   "version": "0.0.0-development",
   "description": "Convenience method to create/edit/delete a text file based on its current content",
   "scripts": {
     "build": "node scripts/build.mjs && tsc -p tsconfig.json",
     "lint": "prettier --check '{src,test}/**/*' README.md package.json",
     "lint:fix": "prettier --write '{src,test}/**/*' README.md package.json",
     "pretest": "npm run -s lint",
-    "test": "jest --coverage"
+    "test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
   },
   "repository": "https://github.com/octokit/plugin-create-or-update-text-file.js",
   "keywords": [
@@ -23,7 +24,7 @@
     "@octokit/types": "^12.0.0"
   },
   "devDependencies": {
-    "@octokit/core": "^6.0.0",
+    "@octokit/core": "^6.0.1",
     "@octokit/tsconfig": "^3.0.0",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.0.0",
@@ -38,14 +39,18 @@
     "typescript": "^5.0.0"
   },
   "peerDependencies": {
-    "@octokit/core": ">= 5"
+    "@octokit/core": ">=6"
   },
   "jest": {
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ],
     "transform": {
       "^.+\\.(ts|tsx)$": [
         "ts-jest",
         {
-          "tsconfig": "test/tsconfig.test.json"
+          "tsconfig": "test/tsconfig.test.json",
+          "useESM": true
         }
       ]
     },
@@ -56,6 +61,9 @@
         "functions": 100,
         "lines": 100
       }
+    },
+    "moduleNameMapper": {
+      "^(.+)\\.jsx?$": "$1"
     }
   },
   "release": {

diff --git a/scripts/build.mjs b/scripts/build.mjs
@@ -2,12 +2,18 @@ import esbuild from "esbuild";
 import { copyFile, readFile, writeFile, rm } from "node:fs/promises";
 import { glob } from "glob";
 
+/**
+ * @type {esbuild.BuildOptions}
+ */
 const sharedOptions = {
   sourcemap: "external",
   sourcesContent: true,
   minify: false,
   allowOverwrite: true,
   packages: "external",
+  format: "esm",
+  target: "es2022",
+  platform: "neutral",
 };
 
 async function main() {
@@ -18,8 +24,6 @@ async function main() {
     entryPoints: await glob(["./src/*.ts", "./src/**/*.ts"]),
     outdir: "pkg/dist-src",
     bundle: false,
-    platform: "neutral",
-    format: "esm",
     ...sharedOptions,
     sourcemap: false,
   });
@@ -33,29 +37,12 @@ async function main() {
     await rm(typeFile);
   }
 
-  const entryPoints = ["./pkg/dist-src/index.js"];
-
-  await Promise.all([
-    // Build the a CJS Node.js bundle
-    esbuild.build({
-      entryPoints,
-      outdir: "pkg/dist-node",
-      bundle: true,
-      platform: "node",
-      target: "node18",
-      format: "cjs",
-      ...sharedOptions,
-    }),
-    // Build an ESM browser bundle
-    esbuild.build({
-      entryPoints,
-      outdir: "pkg/dist-web",
-      bundle: true,
-      platform: "browser",
-      format: "esm",
-      ...sharedOptions,
-    }),
-  ]);
+  await esbuild.build({
+    entryPoints: ["./pkg/dist-src/index.js"],
+    outdir: "pkg/dist-bundle",
+    bundle: true,
+    ...sharedOptions,
+  });
 
   // Copy the README, LICENSE to the pkg folder
   await copyFile("LICENSE", "pkg/LICENSE");
@@ -74,10 +61,17 @@ async function main() {
       {
         ...pkg,
         files: ["dist-*/**", "bin/**"],
-        main: "dist-node/index.js",
+        // Tooling currently are having issues with the "exports" field, ex: TypeScript, eslint
+        // We add a `main` and `types` field to the package.json for the time being
+        main: "dist-bundle/index.js",
         browser: "dist-web/index.js",
         types: "dist-types/index.d.ts",
-        module: "dist-src/index.js",
+        exports: {
+          ".": {
+            types: "./dist-types/index.d.ts",
+            import: "./dist-bundle/index.js",
+          },
+        },
         sideEffects: false,
       },
       null,

diff --git a/src/compose-create-or-update-text-file.ts b/src/compose-create-or-update-text-file.ts
@@ -1,8 +1,12 @@
 import { Octokit } from "@octokit/core";
 
-import { getFileContents } from "./get-file-content";
-import type { Options, Response, ContentUpdateFunctionOptions } from "./types";
-import { utf8ToBase64 } from "./utils";
+import { getFileContents } from "./get-file-content.js";
+import type {
+  Options,
+  Response,
+  ContentUpdateFunctionOptions,
+} from "./types.js";
+import { utf8ToBase64 } from "./utils.js";
 
 /**
  *

diff --git a/src/get-file-content.ts b/src/get-file-content.ts
@@ -1,6 +1,6 @@
 import { RequestError } from "@octokit/request-error";
 import { Octokit } from "@octokit/core";
-import { base64ToUtf8 } from "./utils";
+import { base64ToUtf8 } from "./utils.js";
 
 type Options = {
   owner: string;

diff --git a/src/index.ts b/src/index.ts
@@ -1,11 +1,11 @@
 import { Octokit } from "@octokit/core";
 
-import { composeCreateOrUpdateTextFile } from "./compose-create-or-update-text-file";
-import { VERSION } from "./version";
-import type { Options } from "./types";
+import { composeCreateOrUpdateTextFile } from "./compose-create-or-update-text-file.js";
+import { VERSION } from "./version.js";
+import type { Options } from "./types.js";
 
-export { composeCreateOrUpdateTextFile } from "./compose-create-or-update-text-file";
-export type { Options, Response, ContentUpdateFunction } from "./types";
+export { composeCreateOrUpdateTextFile } from "./compose-create-or-update-text-file.js";
+export type { Options, Response, ContentUpdateFunction } from "./types.js";
 
 /**
  * @param octokit Octokit instance

diff --git a/test/tsconfig.test.json b/test/tsconfig.test.json
@@ -3,7 +3,8 @@
   "compilerOptions": {
     "emitDeclarationOnly": false,
     "noEmit": true,
-    "verbatimModuleSyntax": false
+    "verbatimModuleSyntax": false,
+    "allowImportingTsExtensions": true
   },
   "include": ["src/**/*"]
 }