diff --git a/README.md b/README.md index db78db50d..95e08ec1b 100644 --- a/README.md +++ b/README.md @@ -554,6 +554,12 @@ createOAuthAppAuth({ +> [!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) + ## `auth(options)` or `octokit.auth(options)` The async `auth()` method is returned by `createOAuthUserAuth(options)` or set on the `octokit` instance when the `Octokit` constructor was called with `authStrategy: createOAuthUserAuth`. diff --git a/scripts/build.mjs b/scripts/build.mjs index a1431d931..1e1b2d350 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,