fix: Fix withUt in monorepos

juraj98 commented 1 week ago

Second attempt at fixing #975. I believe this should work. Tested in solidstart in monorepo, and outside of monorepo.

I hope this does what I think it does, but the idea is to add current working directory via process.cwd() to paths require.resolve looks for.

Summary by CodeRabbit

New Features
- Enhanced module resolution for the withUt feature, improving its functionality in monorepo environments.
- Introduced documentation for the patch related to the uploadthing functionality, focusing on compatibility within monorepos.
Documentation
- Updated references in TypeScript configuration comments to direct users to the latest Next.js documentation for better clarity.
Chores
- Simplified Tailwind configuration by removing problematic paths and ensuring it only includes necessary source file paths.

changeset-bot[bot] commented 1 week ago

🦋 Changeset detected

Latest commit: 9e5d41607a37dce715b79ae39997cb22420a8030

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

| Name | Type | | ----------- | ----- | | uploadthing | Patch |

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

vercel[bot] commented 1 week ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 25, 2024 8:00am

1 Skipped Deployment

coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces enhancements to the withUt function in the packages/uploadthing/src/tw.ts file, focusing on improving module resolution by updating the require.resolve function. This adjustment involves incorporating an options object with a paths property for more flexible module resolution. Additionally, several next-env.d.ts files across examples have been updated to reflect new documentation URLs for TypeScript configuration in Next.js, ensuring clarity and accuracy. A new markdown file documenting a patch for the "uploadthing" functionality has also been added.

Changes

Files	Change Summary
packages/uploadthing/src/tw.ts	Modified the `withUt` function to improve module resolution with an updated `require.resolve` function.
examples/minimal-appdir/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/minimal-pagedir/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/profile-picture/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/with-novel/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/with-react-image-crop/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/with-serveractions/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
examples/with-tailwindcss/next-env.d.ts	Updated comment to change TypeScript configuration URL for Next.js documentation.
.changeset/shiny-singers-live.md	Introduced a new markdown file documenting a patch for the "uploadthing" functionality for monorepo compatibility.

Possibly related PRs

#953: This PR addresses path resolution issues in the Tailwind CSS configuration, which is directly related to the changes made in the withUt function for module resolution in the main PR.
#985: This PR introduces a new Tailwind CSS configuration that utilizes the withUt function, indicating a direct connection to the changes made in the main PR regarding the withUt function's operation.
#988: This PR enhances the documentation for SolidStart and includes adjustments related to the uploadRouter, which is relevant to the changes made in the main PR regarding the withUt function and its integration with UploadThing.

Suggested labels

📚 documentation

Suggested reviewers

juliusmarminge

Poem

In the code where rabbits play,
A patch was made, hip-hip-hooray!
With paths aligned, the modules cheer,
In monorepos, they have no fear.
So hop along, let changes flow,
With withUt, the features grow! 🐇✨

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?

:heart: Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

:placard: Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

pingdotgg / uploadthing