Skip to content

Convert TypeScript package to ESM #261

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

Open
Arechii wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Convert TypeScript package to ESM #261

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
66ab161
build: convert TypeScript package to ESM-only
Arechii Apr 30, 2026
8fc95c5
build: address review feedback on ESM conversion
Arechii Aug 18, 2026
eae27cd
docs: clarify module format in npm README
Arechii Aug 18, 2026
c56e023
docs: clarify module format in CLAUDE.md
Arechii Aug 18, 2026
24b386b
docs: state the protocol version in the npm README
Arechii Aug 21, 2026
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
4 changes: 3 additions & 1 deletion .github/workflows/ci-typescript.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ jobs:
--ts_proto_out=./out \
--ts_proto_opt=outputIndex=true \
--ts_proto_opt=globalThisPolyfill=true \
--ts_proto_opt=useExactTypes=false
--ts_proto_opt=useExactTypes=false \
--ts_proto_opt=esModuleInterop=true \
--ts_proto_opt=importSuffix=.js

- name: Compile
run: pnpm run build
Expand Down
10 changes: 8 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@
"type": "git",
"url": "https://github.com/BluEye-Robotics/ProtocolDefinitions.git"
},
"main": "dist/index.js",
"types": "dist/index.d.ts",
"type": "module",
"exports": {
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js"
Comment thread
Arechii marked this conversation as resolved.
Outdated
}
Comment thread
Arechii marked this conversation as resolved.
Outdated
},
"types": "./dist/index.d.ts",
"files": [
"dist"
],
Expand Down
5 changes: 3 additions & 2 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"compilerOptions": {
"target": "ES2020",
"module": "CommonJS",
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"declaration": true,
"outDir": "dist",
"strict": true,
Expand Down
Loading