[PE-193] feat: flat lists (ordered and unordered)

[Palanikannan1437]

Description

This PR adds flat lists to our schema, a migration script that aims to safely convert old lists to new ones and a ton of new improvements to lists

Detailed description

TODO

Summary by CodeRabbit

Release Notes

• New Features

  • Added advanced list management with support for bullet, ordered, task, and toggle lists.
  • Introduced enhanced list manipulation commands (indent, dedent, split, toggle).
  • Implemented improved list rendering and interaction capabilities.
  • Added support for toggling list types within the editor functionality.
  • Enhanced the functionality for handling drop cursors during drag-and-drop operations.
  • Introduced new commands for toggling flat lists and managing list attributes.
  • Added Markdown clipboard support for seamless conversion between HTML and Markdown formats.

• Improvements

  • Enhanced keyboard shortcuts for list operations.
  • Added support for nested and collapsible lists.
  • Improved clipboard and drag-and-drop handling for lists.
  • Enhanced the handling of document migrations for list structures.
  • Streamlined the insertion logic for paragraphs at node boundaries.

• Bug Fixes

  • Resolved issues with list selection and interaction across different browsers.
  • Fixed rendering inconsistencies in list nodes.

• Performance

  • Optimized list rendering and manipulation.
  • Added efficient list serialization and parsing mechanisms.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The pull request introduces a comprehensive enhancement to the list functionality in the Plane editor. It adds a new flat list extension with advanced features like indentation, dedenting, splitting, and various list types (bullet, ordered, task, and toggle). The changes span multiple files, introducing new commands, utilities, and plugins to manage list interactions more effectively. The implementation focuses on improving the user experience by providing more intuitive list management and better handling of list-related operations.

Changes

File	Change Summary
packages/editor/package.json	Added/updated Tiptap list-related dependencies and a Safari IME span package
packages/editor/src/core/components/menus/bubble-menu/node-selector.tsx	Added ToggleListItem to the bubble menu
packages/editor/src/core/components/menus/menu-items.ts	Introduced new list toggle commands and updated existing list item commands
packages/editor/src/core/extensions/...	Comprehensive implementation of flat list extension with multiple utility functions, commands, and plugins
packages/editor/src/core/helpers/editor-commands.ts	Added new list toggle commands
packages/editor/src/core/hooks/use-editor.ts	Added document migration support for list nodes
packages/editor/src/core/types/editor.ts	Added "toggle-list" to editor commands
packages/editor/src/index.ts	Imported new list-related CSS files

Sequence Diagram

Loading

sequenceDiagram
    participant User
    participant Editor
    participant ListExtension
    participant ListCommands

    User->>Editor: Interact with list
    Editor->>ListExtension: Detect list interaction
    ListExtension->>ListCommands: Trigger appropriate command
    alt Indent List
        ListCommands->>Editor: Increase list item depth
    else Dedent List
        ListCommands->>Editor: Decrease list item depth
    else Toggle List Type
        ListCommands->>Editor: Change list type
    else Split List
        ListCommands->>Editor: Split current list item
    end
    ListExtension->>Editor: Update document state

Poem

🐰 A Rabbit's Ode to Flat Lists 🍃

With tabs and shifts, we dance and weave,
Lists that indent and gently cleave,
Bullet, ordered, task, and more,
Our editor opens a brand new door!

Hop, hop, hurray for structured text! 🎉

---

🪧 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 generate docstrings to generate docstrings for 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]

Pull Request Linked with Plane Issues

• [PE-193] Lists revamp

Comment Automatically Generated by Plane