Skip to content
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

Bumps ion-js peer- and dev-dependency to 5.2.0. #62

Merged
merged 5 commits into from
Dec 5, 2023
Merged

Conversation

linlin-s
Copy link
Contributor

Issue #, if available:
#61
Description of changes:
Bumps ion-js peer- and dev-dependency to 5.2.0. Upgrade jsbi and typedoc version to resolve conflicts.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

package.json Outdated
"jsbi": "3.1.1",
"typedoc": "^0.17.3",
"ion-js": "^5.2.0",
"jsbi": "^4.3.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is JSBI even required—can we just remove it from the dependencies completely?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can remove it from the dependencies. There are build errors caused by incompatible dependency versions and I'm looking into it.

Comment on lines +11 to +12
// TODO: Temporarily skipping the type checking of all declaration files in the node_modules directory. More investigations required to resolve the compiling error when setting this option as false
"skipLibCheck": true
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This gives me pause--I'd like to better understand what we're skipping by doing this. Are downstream users of our library impacted by this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When skipLibCheck is set to true, it enables TypeScript to bypass type checking for declaration files. We've encountered a scenario where setting this option to false results in type inconsistency errors originating from the intern dependency. We have updated this dependency to its latest version and found no related issues in its repository. Since this inconsistency stems from the third-party dependency's type declarations, in my opinion, this configuration should not affect our downstream customers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created this issue #63 as a reference point to help identify the root cause in case any typechecking-related issues arise in the future.

@linlin-s linlin-s merged commit 24cbf39 into master Dec 5, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants