fix: update exports to support both vite and react-scripts builds #134
Conversation
WalkthroughThe changes introduce explicit imports and exports for authentication-related components and types in the main entry points of the codebase. The build configuration is updated to refine output formats, entry points, and type generation, improving clarity and structure in the build output and public API surface. Changes
Sequence Diagram(s)sequenceDiagram
participant App
participant src/index.ts
participant components/index.ts
participant LoginLink
participant LogoutLink
participant RegisterLink
App->>src/index.ts: import { LoginLink, LogoutLink, RegisterLink }
src/index.ts->>components/index.ts: import { LoginLink, LogoutLink, RegisterLink }
components/index.ts->>LoginLink: import LoginLink
components/index.ts->>LogoutLink: import LogoutLink
components/index.ts->>RegisterLink: import RegisterLink
src/index.ts-->>App: export { LoginLink, LogoutLink, RegisterLink }
Suggested labels
Suggested reviewers
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
vite.config.ts (1)
40-61: Well-structured dual output configurationThe explicit configuration for both ES and CommonJS formats with preserved module structure is excellent. This ensures compatibility with both Vite and React-Scripts build environments.
I noticed a small redundancy in the entryFileNames functions where the conditions don't affect the output:
entryFileNames: (chunkInfo) => { - return chunkInfo.name === "index" ? "[name].mjs" : "[name].mjs"; + return "[name].mjs"; }But this is just a minor nitpick, not a functional issue.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
package-lock.jsonis excluded by!**/package-lock.json,!**/*.jsonpackage.jsonis excluded by!**/*.json
📒 Files selected for processing (3)
src/components/index.ts(1 hunks)src/index.ts(1 hunks)vite.config.ts(2 hunks)
🔇 Additional comments (6)
vite.config.ts (2)
22-23: Good enhancement to entry path structureThe change to use explicit subpath keys like "components/index" and "utils/index" improves the clarity of the entry point structure and aligns better with the overall modular architecture.
65-72: Good plugin configuration for type generationAdding
rollupTypes: trueto the dts plugin configuration improves type generation support, which is essential for TypeScript consumers of this library.src/components/index.ts (1)
1-4: Import pattern supports build compatibilityAdding explicit imports for components that are also re-exported helps certain bundlers correctly understand the module structure. While this creates some redundancy, it's a common pattern used to ensure compatibility across different build systems.
src/index.ts (3)
1-6: Well-structured imports improve module clarityThe explicit imports for all exports help ensure that the module structure is clear to bundlers. This is particularly important for supporting both Vite and React-Scripts builds.
7-10: Good organizational comment and explicit exportsAdding the "Main exports" comment improves code organization. The explicit export of component links from "./components" ensures they're properly available in both build environments.
14-14: Properly exposed KindeContextProps typeAdding an explicit export for the KindeContextProps type ensures it's properly available to consumers of the library.
Explain your changes
This change enables support for both Vite and React-Script projects.
Checklist
🛟 If you need help, consider asking for advice over in the Kinde community.