Skip to content

Commit 181a0c2

Browse files
committed
feat: package is now ESM
BREAKING CHANGE: package is now ESM
1 parent ccf4d60 commit 181a0c2

File tree

5 files changed

+77
-69
lines changed

5 files changed

+77
-69
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,7 @@ Node
4444
Install with <code>npm install @octokit/auth-unauthenticated</code>
4545

4646
```js
47-
const { createUnauthenticatedAuth } = require("@octokit/auth-unauthenticated");
48-
// or: import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
47+
import { createUnauthenticatedAuth } from "@octokit/auth-unauthenticated";
4948
```
5049

5150
</td></tr>

package-lock.json

Lines changed: 47 additions & 52 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@
33
"publishConfig": {
44
"access": "public"
55
},
6+
"type": "module",
67
"version": "0.0.0-development",
78
"description": "GitHub API token authentication for browsers and Node.js",
89
"scripts": {
910
"build": "node scripts/build.mjs && tsc -p tsconfig.json",
1011
"lint": "prettier --check 'src/**/*.ts' 'test/**/*.ts' '*.md' package.json",
1112
"lint:fix": "prettier --write 'src/**/*.ts' 'test/**/*.ts' '*.md' package.json",
1213
"pretest": "npm run lint -s",
13-
"test": "jest --coverage"
14+
"test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage"
1415
},
1516
"repository": "github:octokit/auth-unauthenticated.js",
1617
"keywords": [
@@ -22,13 +23,13 @@
2223
"author": "Gregor Martynus (https://github.com/gr2m)",
2324
"license": "MIT",
2425
"dependencies": {
25-
"@octokit/request-error": "^5.0.0",
26+
"@octokit/request-error": "^6.0.1",
2627
"@octokit/types": "^12.0.0"
2728
},
2829
"devDependencies": {
29-
"@octokit/core": "^5.0.0",
30-
"@octokit/request": "^8.0.2",
31-
"@octokit/tsconfig": "^2.0.0",
30+
"@octokit/core": "^6.0.0",
31+
"@octokit/request": "^9.0.0",
32+
"@octokit/tsconfig": "^3.0.0",
3233
"@types/jest": "^29.0.0",
3334
"esbuild": "^0.20.0",
3435
"fetch-mock": "npm:@gr2m/fetch-mock@^9.11.0-pull-request-644.1",
@@ -39,11 +40,15 @@
3940
"typescript": "^5.0.0"
4041
},
4142
"jest": {
43+
"extensionsToTreatAsEsm": [
44+
".ts"
45+
],
4246
"transform": {
4347
"^.+\\.(ts|tsx)$": [
4448
"ts-jest",
4549
{
46-
"tsconfig": "test/tsconfig.test.json"
50+
"tsconfig": "test/tsconfig.test.json",
51+
"useESM": true
4752
}
4853
]
4954
},

scripts/build.mjs

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ const sharedOptions = {
1212
minify: false,
1313
allowOverwrite: true,
1414
packages: "external",
15+
format: "esm",
1516
};
1617

1718
async function main() {
@@ -23,7 +24,6 @@ async function main() {
2324
outdir: "pkg/dist-src",
2425
bundle: false,
2526
platform: "neutral",
26-
format: "esm",
2727
...sharedOptions,
2828
sourcemap: false,
2929
});
@@ -46,8 +46,7 @@ async function main() {
4646
outdir: "pkg/dist-node",
4747
bundle: true,
4848
platform: "node",
49-
target: "node14",
50-
format: "cjs",
49+
target: "node18",
5150
...sharedOptions,
5251
}),
5352
// Build an ESM browser bundle
@@ -56,7 +55,6 @@ async function main() {
5655
outdir: "pkg/dist-web",
5756
bundle: true,
5857
platform: "browser",
59-
format: "esm",
6058
...sharedOptions,
6159
}),
6260
]);
@@ -78,10 +76,22 @@ async function main() {
7876
{
7977
...pkg,
8078
files: ["dist-*/**", "bin/**"],
81-
main: "dist-node/index.js",
82-
module: "dist-web/index.js",
83-
types: "dist-types/index.d.ts",
84-
source: "dist-src/index.js",
79+
exports: {
80+
".": {
81+
node: {
82+
types: "./dist-types/index.d.ts",
83+
import: "./dist-node/index.js",
84+
},
85+
browser: {
86+
types: "./dist-types/web.d.ts",
87+
import: "./dist-web/index.js",
88+
},
89+
default: {
90+
types: "./dist-types/index.d.ts",
91+
import: "./dist-node/index.js",
92+
},
93+
},
94+
},
8595
sideEffects: false,
8696
},
8797
null,

test/tsconfig.test.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
"compilerOptions": {
44
"emitDeclarationOnly": false,
55
"noEmit": true,
6-
"verbatimModuleSyntax": false,
76
"allowImportingTsExtensions": true
87
},
98
"include": ["src/**/*"]

0 commit comments

Comments
 (0)