Skip to content

Commit 6c5bafb

Browse files
authored
feat: package is now ESM (#716)
* feat: package is now ESM BREAKING CHANGE: package is now ESM * build: remove bundle, package is already small
1 parent 2a7fce7 commit 6c5bafb

File tree

12 files changed

+84
-208
lines changed

12 files changed

+84
-208
lines changed

.github/workflows/update.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818
token: ${{ secrets.OCTOKITBOT_PAT }}
1919
- uses: actions/setup-node@v4
2020
with:
21-
node-version: 16
21+
node-version: 20
2222
cache: npm
2323
- run: git checkout routes-update || true
2424
- run: npm install @octokit/types@latest

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,8 @@ Node
3030
Install with `npm install @octokit/core @octokit/plugin-rest-endpoint-methods`. Optionally replace `@octokit/core` with a compatible module
3131

3232
```js
33-
const { Octokit } = require("@octokit/core");
34-
const {
35-
restEndpointMethods,
36-
} = require("@octokit/plugin-rest-endpoint-methods");
33+
import { Octokit } from "@octokit/core";
34+
import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
3735
```
3836

3937
</td></tr>

package-lock.json

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

package.json

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
{
22
"name": "@octokit/plugin-rest-endpoint-methods",
33
"version": "0.0.0-development",
4+
"type": "module",
45
"description": "Octokit plugin adding one method for all of api.github.com REST API endpoints",
56
"scripts": {
67
"build": "node scripts/build.mjs && tsc -p tsconfig.json",
78
"lint": "prettier --check '{src,test,scripts}/**/*' '!scripts/update-endpoints/generated/**' '!src/generated/**' README.md package.json",
89
"lint:fix": "prettier --write '{src,test,scripts}/**/*' '!scripts/update-endpoints/generated/**' '!src/generated/**' README.md package.json",
910
"pretest": "npm run -s lint",
10-
"test": "jest --coverage",
11+
"test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" npx jest --coverage",
1112
"update-endpoints": "npm-run-all update-endpoints:*",
1213
"update-endpoints:fetch-json": "node scripts/update-endpoints/fetch-json.mjs",
1314
"update-endpoints:code": "node scripts/update-endpoints/code.mjs",
@@ -27,8 +28,8 @@
2728
"@octokit/types": "^12.6.0"
2829
},
2930
"devDependencies": {
30-
"@octokit/core": "^5.0.0",
31-
"@octokit/tsconfig": "^2.0.0",
31+
"@octokit/core": "^6.0.0",
32+
"@octokit/tsconfig": "^3.0.0",
3233
"@types/fetch-mock": "^7.3.1",
3334
"@types/jest": "^29.0.0",
3435
"@types/node": "^20.0.0",
@@ -52,14 +53,18 @@
5253
"typescript": "^5.0.0"
5354
},
5455
"peerDependencies": {
55-
"@octokit/core": ">=5"
56+
"@octokit/core": ">=6"
5657
},
5758
"jest": {
59+
"extensionsToTreatAsEsm": [
60+
".ts"
61+
],
5862
"transform": {
5963
"^.+\\.(ts|tsx)$": [
6064
"ts-jest",
6165
{
62-
"tsconfig": "test/tsconfig.test.json"
66+
"tsconfig": "test/tsconfig.test.json",
67+
"useESM": true
6368
}
6469
]
6570
},

0 commit comments

Comments
 (0)