Skip to content

Commit

Permalink
fix(pkg): add a default fallback export (#542)
Browse files Browse the repository at this point in the history
Co-authored-by: wolfy1339 <webmaster@wolfy1339.com>
  • Loading branch information
KyleBoyer and wolfy1339 committed Apr 23, 2024
1 parent 6a0722f commit 4cc1275
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Expand Up @@ -38,6 +38,12 @@ import { retry } from "@octokit/plugin-retry";
</tbody>
</table>

> [!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).<br>
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)
```js
const MyOctokit = Octokit.plugin(retry);
const octokit = new MyOctokit({ auth: "secret123" });
Expand Down
5 changes: 4 additions & 1 deletion scripts/build.mjs
Expand Up @@ -60,12 +60,15 @@ 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, ncc, jest
// See https://github.com/octokit/core.js/issues/667#issuecomment-2037592361
// See https://github.com/octokit/plugin-retry.js/issues/541
default: "./dist-bundle/index.js",
},
},
sideEffects: false,
Expand Down

0 comments on commit 4cc1275

Please sign in to comment.