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

chore: fix type generation for es build #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

isaacpovey
Copy link

Explain your changes

Fixes issue with typescript being unable to import methods/types that are not the init method when building a project of "type: module".

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Copy link
Contributor

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes in the vite.config.ts file involve modifications to the build settings and plugin configurations. The outDir property has been removed, and the root property has been updated to reflect a new directory structure. The plugins array has been adjusted to include a new configuration for the dts plugin, specifically setting rollupTypes: true. The target property remains unchanged, with minor formatting adjustments made to the file.

Changes

File Change Summary
vite.config.ts Removed outDir from build, changed root from "lib" to ".", updated dts plugin to include rollupTypes: true, and adjusted formatting by removing a trailing comma.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Vite
    participant Plugin

    User->>Vite: Initiates build process
    Vite->>Plugin: Configures plugins
    Plugin-->>Vite: Plugins configured
    Vite->>User: Build artifacts generated
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)
vite.config.ts (1)

19-19: Good fix: Proper type generation configuration for ES modules

The addition of rollupTypes: true is essential for fixing the type generation issues with ES modules. This ensures that TypeScript can properly import all methods and types when using "type: module".

Some additional benefits of this configuration:

  • Generates a single type definition bundle
  • Improves compatibility with ES module imports
  • Maintains proper type references across the package

Consider adding a type checking script in your CI pipeline to verify the generated types:

// package.json
{
  "scripts": {
+   "type-check": "tsc --noEmit",
+   "test-types": "tsc --project tsconfig.json --noEmit"
  }
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 31243b8 and bc8156d.

⛔ Files ignored due to path filters (2)
  • package.json is excluded by !**/*.json
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml, !**/*.yaml
📒 Files selected for processing (1)
  • vite.config.ts (1 hunks)
🔇 Additional comments (1)
vite.config.ts (1)

16-18: LGTM: Directory structure changes look correct

Moving the root to "." while maintaining the lib directory as the source through aliases is a good approach. This helps separate source files while keeping the build configuration at the project root.

@@ -11,11 +11,10 @@ export default defineConfig({
name: "@kinde/management-api-js",
fileName: "kinde-management-api-js",
},
target: "esnext",
outDir: "../dist",
target: "esnext"
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Target mismatch between Vite and TypeScript configurations

The Vite config uses "esnext" while TypeScript is configured with "ES2022". This mismatch could lead to inconsistencies in the generated code and type declarations. Update the Vite build target to match TypeScript's "ES2022" for consistent behavior.

🔗 Analysis chain

Verify ESNext compatibility with type generation

The esnext target is appropriate for modern JavaScript features, but ensure it aligns with your TypeScript configuration and supported environments.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check TypeScript config for target compatibility
rg -l "compilerOptions" --type json
rg '"target"' --type json -A 2

Length of output: 209

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.

1 participant