-
Notifications
You must be signed in to change notification settings - Fork 0
build(css-var-ts): fix external #3
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
Conversation
🦋 Changeset detectedLatest commit: c26899c The changes in this PR will be included in the next version bump. This PR includes changesets to release 6 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello @VdustR, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a critical build configuration problem within the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
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.
Code Review
This pull request correctly configures the build to treat randombytes and slugify as external dependencies. However, this change, combined with them being optionalDependencies, introduces a critical risk of runtime errors for consumers of the package. My review includes a detailed comment explaining the issue and suggesting a fix to ensure the package is robust and reliable for its users.
| entry: ["src/index.ts"], | ||
| tsconfig: "tsconfig.lib.json", | ||
| dts: true, | ||
| external: ["randombytes", "slugify"], |
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.
While marking randombytes and slugify as external is correct to prevent them from being bundled, there's a significant issue with them being listed as optionalDependencies in package.json.
When these dependencies are external, the library expects the runtime environment (i.e., the consumer of your library) to provide them. However, since they are marked as optionalDependencies, there is no guarantee they will be installed.
If a consumer of @crescendolab/css-var-ts does not have randombytes or slugify installed, any attempt to use functions from your library that depend on them (like randomString or slugify from src/) will result in a runtime error, crashing the application.
To fix this, you should move randombytes and slugify from optionalDependencies to either:
dependencies: If you want them to be automatically installed alongside your package.peerDependencies: If you expect the consumer of your library to explicitly install them.
Given their direct usage, dependencies seems more appropriate. This will ensure they are always available at runtime, resolving the potential for crashes.
This pull request addresses a build configuration issue in the
@crescendolab/css-var-tspackage by updating the external dependencies list to ensure proper bundling and compatibility.Build configuration fixes:
randombytesandslugifyto theexternalarray intsdown.config.tsto prevent these dependencies from being bundled, which resolves issues with external modules during the build process..changeset/shaggy-ants-fail.mdfor proper versioning and release notes.