Skip to content

fix(pkg): add default fallback and types export #419

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 6 commits into from
Apr 16, 2024
Merged

fix(pkg): add default fallback and types export #419

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ed83ba5
fix(pkg): add a default fallback
wolfy1339 Apr 15, 2024
54e799b
docs: add note on needed config changes for TypeScript
wolfy1339 Apr 15, 2024
7229916
docs(README): change info to important
wolfy1339 Apr 15, 2024
a7df52f
Merge branch 'main' into fix-esm-exports
wolfy1339 Apr 16, 2024
ccf3a29
Update README.md
wolfy1339 Apr 16, 2024
8b31afe
Empty commit to trigger tests
wolfy1339 Apr 16, 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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ import { RequestError } from "@octokit/request-error";
</tbody>
</table>

> [!IMPORTANT]
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json`. See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).

```js
const error = new RequestError("Oops", 500, {
request: {
Expand Down
3 changes: 2 additions & 1 deletion scripts/build.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,13 @@ async function main() {
{
...pkg,
files: ["dist-*/**", "bin/**"],
main: "./dist-src/index.js",
types: "./dist-types/index.d.ts",
exports: {
".": {
types: "./dist-types/index.d.ts",
import: "./dist-src/index.js",
// Tooling currently are having issues with the "exports" field when there is no "default", ex: TypeScript, eslint
default: "./dist-src/index.js",
}
},
sideEffects: false,
Expand Down