Skip to content

Added "default" export in package.json #195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 23, 2024
Merged

Added "default" export in package.json #195

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dc1befc
Added "default" export in package.json
KyleBoyer Apr 23, 2024
81d0712
Update README.md
KyleBoyer Apr 23, 2024
1cc3a84
Update scripts/build.mjs
wolfy1339 Apr 23, 2024
4c24a5f
Update scripts/build.mjs
wolfy1339 Apr 23, 2024
0618dae
remove main field
wolfy1339 Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ import { paginateGraphQL } from "@octokit/plugin-paginate-graphql";
</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(paginateGraphQL);
const octokit = new MyOctokit({ auth: "secret123" });
Expand Down
1 change: 1 addition & 0 deletions scripts/build.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ async function main() {
".": {
types: "./dist-types/index.d.ts",
import: "./dist-bundle/index.js",
default: "./dist-bundle/index.js",
}
},
sideEffects: false,
Expand Down