From 0d4c2be4e400e7ec1c13721f67a86da20a1ce83b Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Tue, 16 Apr 2024 14:45:58 -0400 Subject: [PATCH 1/2] fix(pkg): add a default fallback export --- scripts/build.mjs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/build.mjs b/scripts/build.mjs index 9682096..9fababa 100644 --- a/scripts/build.mjs +++ b/scripts/build.mjs @@ -58,12 +58,13 @@ async function main() { { ...pkg, files: ["dist-*/**", "bin/**"], - main: "./dist-bundle/index.js", types: "./dist-types/index.d.ts", exports: { ".": { types: "./dist-types/index.d.ts", import: "./dist-bundle/index.js", + // Tooling currently are having issues with the "exports" field when there is no "default", ex: TypeScript, eslint + default: "./dist-bundle/index.js", }, }, sideEffects: false, From 090c21c170262ebe752716979f24a03bd378ac57 Mon Sep 17 00:00:00 2001 From: wolfy1339 Date: Tue, 16 Apr 2024 14:46:06 -0400 Subject: [PATCH 2/2] docs: add note on needed config changes for TypeScript --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 46e05f2..32249b7 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,12 @@ import { createOAuthDeviceAuth } from "@octokit/auth-oauth-device"; +> [!IMPORTANT] +> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`. +> +> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).
+> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus) + ### For OAuth Apps ```js