Skip to content

[WEB-4223] fix: remove build process from utils package#7138

Merged
sriramveeraghanta merged 1 commit intopreviewfrom
remove-utils-build
May 30, 2025
Merged

[WEB-4223] fix: remove build process from utils package#7138
sriramveeraghanta merged 1 commit intopreviewfrom
remove-utils-build

Conversation

@sriramveeraghanta
Copy link
Member

@sriramveeraghanta sriramveeraghanta commented May 30, 2025

Description

This pull request addresses the removal of the build process from the utils package. The build process was deemed unnecessary for this package, as it primarily contains utility functions that do not require compilation or transformation.

Type of Change

  • Improvement (change that would cause existing functionality to not work as expected)

Summary by CodeRabbit

  • Chores

    • Updated internal configuration for the utilities package to improve organization and remove unnecessary build references.
  • Refactor

    • Improved the organization of export statements for better clarity and removed duplicate exports. No changes to available features or functionality.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 30, 2025

Walkthrough

The changes update the @plane/utils package configuration to reference TypeScript source files directly instead of build outputs, removing the build script and related dependencies. Additionally, the export statements in the main source file were reordered to eliminate duplicates and improve organization, without altering the actual exports.

Changes

File(s) Change Summary
packages/utils/package.json Updated to reference src/index.ts for entry points, removed build script and tsup dependency, deleted files array.
packages/utils/src/index.ts Reordered and consolidated export statements for clarity; removed duplicate exports.

Poem

In the meadow of code, a rabbit hops through,
Tidying exports, making paths new.
No more builds to chase or bundles to find,
Just TypeScript source, simple and kind.
With a whisk of its paw and a twitch of its nose,
The utils are cleaner—onward it goes! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

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.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need 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)

  • @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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@makeplane
Copy link

makeplane bot commented May 30, 2025

Pull Request Linked with Plane Work Items

Comment Automatically Generated by Plane

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: 0

🧹 Nitpick comments (1)
packages/utils/package.json (1)

10-13: Add a type-checking script for early error detection
Since the build process has been removed, consider adding a typecheck script (tsc --noEmit) to catch type errors during development. This helps maintain type safety without requiring output artifacts.
Apply this diff:

--- a/packages/utils/package.json
+++ b/packages/utils/package.json
@@
   "scripts": {
     "lint": "eslint src --ext .ts,.tsx",
     "lint:errors": "eslint src --ext .ts,.tsx --quiet",
+    "typecheck": "tsc --noEmit"
   },
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a97d7c and 63687ec.

⛔ Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • packages/utils/package.json (1 hunks)
  • packages/utils/src/index.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (4)
packages/utils/package.json (1)

7-9: Verify TypeScript entry points in package.json
Ensure consuming environments (Node.js, bundlers, or the TypeScript compiler) can resolve and transpile .ts entry points without a build step. Without compiled outputs, imports like import { foo } from "@plane/utils" must be supported via an appropriate loader or toolchain configuration.

packages/utils/src/index.ts (3)

9-9: Approve repositioning of get-icon-for-link export
Moving export * from "./get-icon-for-link"; adjacent to related utilities improves logical grouping. No duplicates detected.


13-13: Approve relocation of subscription export
Consolidating export * from "./subscription"; enhances the consistency of the export order. Looks good.


16-16: Approve workspace export ordering
Reordering export * from "./workspace"; aligns with the new grouping strategy. No functional changes detected.

@sriramveeraghanta sriramveeraghanta merged commit 322af8c into preview May 30, 2025
13 of 14 checks passed
@sriramveeraghanta sriramveeraghanta deleted the remove-utils-build branch May 30, 2025 13:18
@coderabbitai coderabbitai bot mentioned this pull request Jul 18, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants