Skip to content

[WEB-4514]chore: moved EIssueLayoutTypes enum to types#7416

Merged
pushya22 merged 1 commit intopreviewfrom
chore-enum_to_types
Jul 17, 2025
Merged

[WEB-4514]chore: moved EIssueLayoutTypes enum to types#7416
pushya22 merged 1 commit intopreviewfrom
chore-enum_to_types

Conversation

@vamsikrishnamathala
Copy link
Member

@vamsikrishnamathala vamsikrishnamathala commented Jul 15, 2025

Description

This update moves EIssueLayoutTypes enum from constants to types.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Summary by CodeRabbit

  • Refactor
    • Centralized the definition of issue layout types by moving the enum to a shared location, reducing redundancy across the application.
    • Updated all relevant areas to reference the new shared enum for issue layout types, with no changes to user-facing functionality or behavior.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 15, 2025

Walkthrough

The changes move the definition and import of the EIssueLayoutTypes enum from the @plane/constants package to the @plane/types package. All affected files now import EIssueLayoutTypes from @plane/types, and the local enum definition is removed from the constants package. No logic or runtime behavior is changed.

Changes

Files/Groups Change Summary
apps/web/app/(all)/[workspaceSlug]/(projects)/.../*.ts(x)
apps/web/ce/components/issues/quick-add/root.tsx
apps/web/ce/components/views/helper.tsx
apps/web/core/components/dropdowns/layout.tsx
apps/web/core/components/issues/filters.tsx
apps/web/core/components/issues/issue-layouts/calendar/calendar.tsx
apps/web/core/components/issues/issue-layouts/calendar/quick-add-issue-actions.tsx
apps/web/core/components/issues/issue-layouts/filters/header/layout-selection.tsx
apps/web/core/components/issues/issue-layouts/gantt/base-gantt-root.tsx
apps/web/core/components/issues/issue-layouts/issue-layout-HOC.tsx
apps/web/core/components/issues/issue-layouts/kanban/base-kanban-root.tsx
apps/web/core/components/issues/issue-layouts/kanban/kanban-group.tsx
apps/web/core/components/issues/issue-layouts/layout-icon.tsx
apps/web/core/components/issues/issue-layouts/list/base-list-root.tsx
apps/web/core/components/issues/issue-layouts/list/list-group.tsx
apps/web/core/components/issues/issue-layouts/quick-add/root.tsx
apps/web/core/components/issues/issue-layouts/roots/all-issue-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/cycle-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/draft-issue-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/module-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/project-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/project-view-layout-root.tsx
apps/web/core/components/issues/issue-layouts/spreadsheet/base-spreadsheet-root.tsx
apps/web/core/components/issues/issue-layouts/spreadsheet/roots/workspace-root.tsx
apps/web/core/components/issues/issue-layouts/spreadsheet/spreadsheet-view.tsx
apps/web/core/components/profile/profile-issues-filter.tsx
apps/web/core/components/views/form.tsx
apps/web/core/components/views/helper.tsx
apps/web/core/components/workspace/views/form.tsx
apps/web/core/store/issue/helpers/base-issues.store.ts
apps/web/core/store/issue/helpers/issue-filter-helper.store.ts
apps/web/core/store/issue/workspace/filter.store.ts
apps/web/core/components/issues/issue-layouts/roots/project-view-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/project-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/module-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/draft-issue-layout-root.tsx
apps/web/core/components/issues/issue-layouts/roots/cycle-layout-root.tsx
Changed import of EIssueLayoutTypes from @plane/constants to @plane/types. No logic changes.
packages/constants/src/issue/layout.ts Removed local enum EIssueLayoutTypes, now imports it from @plane/types.
packages/types/src/issues/issue.ts Added exported enum EIssueLayoutTypes with five layout type members.
packages/utils/src/work-item/base.ts Changed import of EIssueLayoutTypes from @plane/constants to @plane/types.

Sequence Diagram(s)

sequenceDiagram
    participant File as Any Consuming File
    participant Types as @plane/types
    participant Constants as @plane/constants

    File->>Types: import { EIssueLayoutTypes }
    Note right of Types: EIssueLayoutTypes is now defined and exported here
    File--xConstants: (No longer imports EIssueLayoutTypes)
Loading

Possibly related PRs

  • makeplane/plane#7214: Introduces new layout-aware filtering and UI components using EIssueLayoutTypes, related by involvement of the same enum.

Suggested labels

ready_to_merge

Suggested reviewers

  • prateekshourya29

Poem

A hop and a skip, enum on the move,
From constants to types, we tidy and improve.
No logic disturbed, just imports aligned,
Now all our layouts are neatly defined.
🐇✨
Hooray for clean code, and enums that shine!

✨ 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.

@vamsikrishnamathala vamsikrishnamathala self-assigned this Jul 16, 2025
@vamsikrishnamathala vamsikrishnamathala changed the title chore: moved EIssueLayoutTypes enum to types [WEB-4514]chore: moved EIssueLayoutTypes enum to types Jul 16, 2025
@vamsikrishnamathala vamsikrishnamathala marked this pull request as ready for review July 16, 2025 07:51
@makeplane
Copy link

makeplane bot commented Jul 16, 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: 1

🔭 Outside diff range comments (2)
apps/web/core/store/issue/helpers/issue-filter-helper.store.ts (1)

218-226: Broken index check causes false negatives and a crash

currentFilterIndex is a number.
!currentFilterIndex treats index 0 as “not found”, and accessing .length on a number (currentFilterIndex.length) throws at runtime.

-      if (!currentFilterIndex && currentFilterIndex.length < 0) return undefined;
+      // ‑1 means “not found”; 0 is a valid index
+      if (currentFilterIndex < 0) return undefined;
packages/constants/src/issue/layout.ts (1)

34-60: Potential runtime holes in ISSUE_LAYOUT_MAP

If the enum value stays "gantt_chart" while key is typed as EIssueLayoutTypes, the map is internally consistent.
However downstream consumers that do something like:

ISSUE_LAYOUT_MAP["gantt"]

will now return undefined, whereas that worked before.
Please add an exhaustive unit-test that iterates over EIssueLayoutTypes and asserts that every enum member is present in ISSUE_LAYOUT_MAP and vice-versa. That would have caught this regression.

🧹 Nitpick comments (1)
apps/web/app/(all)/[workspaceSlug]/(projects)/projects/(detail)/[projectId]/issues/(list)/mobile-header.tsx (1)

9-17: Import source updated – good.

Same observation as in the modules header: ensure ISSUE_LAYOUTS keys line up with the enum’s literal values to preserve type-safety.

Consider exporting ISSUE_LAYOUTS from @plane/types (or co-locating it with the enum) in a future cleanup so the layout metadata and enum stay in one place.

@pushya22 pushya22 merged commit 9523c28 into preview Jul 17, 2025
5 of 6 checks passed
@pushya22 pushya22 deleted the chore-enum_to_types branch July 17, 2025 07:31
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.

3 participants