-
Notifications
You must be signed in to change notification settings - Fork 1
Add ES module compliance testing #34
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.
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
GabiGrin
wants to merge
1
commit into
main
Choose a base branch
from
test/esm-compliance-check
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,3 +25,6 @@ jobs: | |
|
|
||
| - name: Run unit tests | ||
| run: npm run test:unit | ||
|
|
||
| - name: Test ES module compliance | ||
| run: npm run test:esm | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| /** | ||
| * Strict ES module test - runs with Node.js directly | ||
| * This will fail if imports don't have proper .js extensions | ||
| */ | ||
| import { createClient } from './dist/index.js'; | ||
|
|
||
| console.log('✅ ES module import successful'); | ||
| console.log('createClient:', typeof createClient); | ||
|
|
||
| const client = createClient({ | ||
| apiKey: 'test-key', | ||
| baseURL: 'https://api.test.com' | ||
| }); | ||
|
|
||
| console.log('✅ Client creation successful'); | ||
| process.exit(0); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| /** | ||
| * Test to verify ES module compliance by importing the built SDK | ||
| * This test runs against the compiled output to catch import issues | ||
| */ | ||
| import { createClient } from '../dist/index.js'; | ||
| import { describe, it, expect } from 'vitest'; | ||
|
|
||
| describe('ES Module Compliance', () => { | ||
| it('should import the SDK successfully from built dist', () => { | ||
| expect(createClient).toBeDefined(); | ||
| expect(typeof createClient).toBe('function'); | ||
| }); | ||
|
|
||
| it('should create a client instance', () => { | ||
| const client = createClient({ | ||
| apiKey: 'test-key', | ||
| baseURL: 'https://api.test.com' | ||
| }); | ||
| expect(client).toBeDefined(); | ||
| }); | ||
| }); | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
does this really catch stuff? aren't we good with test:esm? might be nicer DX to not have to run
buildto run the unit testsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I verified it would have failed with the issue that I fixed in #33
if you have a better way to prevent sdk breaking prod let me know and I'll change
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can move to "e2e" to be semantically correct