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

fix(table): allow parsing for TH elements in table module #531

Conversation

cycleccc
Copy link
Collaborator

@cycleccc cycleccc commented Feb 5, 2025

Changes Overview

Implementation Approach

Testing Done

Verification Steps

Additional Notes

Checklist

  • I have created a changeset for this PR if necessary.
  • My changes do not break the library.
  • I have added tests where applicable.
  • I have followed the project guidelines.
  • I have fixed any lint issues.

Related Issues

Summary by CodeRabbit

  • New Features
    • Enhanced table styling so that header cells (TH elements) are now processed properly, ensuring a more consistent presentation of table content.

Copy link
Contributor

coderabbitai bot commented Feb 5, 2025

Walkthrough

The pull request updates the parseStyleHtml function in parse-style-html.ts to expand its validation logic. Previously, the function returned the node if the element’s tag name was not 'TABLE' or 'TD'. With this change, the allowed tag names now include 'TH', meaning that the function will process table header elements along with tables and table cells.

Changes

File Change Summary
packages/table-module/.../parse-style-html.ts Modified the tag name validation to include 'TH' in addition to 'TABLE' and 'TD'.
.changeset/hip-hairs-tell.md Introduced a fix in the table module to enhance the parsing of TH elements. Added method fix(table) in module @wangeditor-next/table-module.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Parser as parseStyleHtml
    Caller ->> Parser: call with an element
    alt element.tagName is one of ["TABLE", "TD", "TH"]
        Parser -->> Caller: Process element further
    else element.tagName is not one of ["TABLE", "TD", "TH"]
        Parser -->> Caller: Return original node
    end
Loading

Possibly related PRs

Poem

I’m a little code rabbit, hopping by with glee,
Found a tiny change in our HTML tree.
Now ‘TH’ joins the crew, as clear as can be,
Tables and cells dance along merrily.
Code carrots crunch in this joyful spree!
🥕🐇 Happy hopping in our coding spree!

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2360160 and 0c6a3d8.

📒 Files selected for processing (1)
  • .changeset/hip-hairs-tell.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test-e2e
  • GitHub Check: test
🔇 Additional comments (2)
.changeset/hip-hairs-tell.md (2)

1-4: Commit Changeset Header is Clear and Correct

The changeset header properly lists the targeted packages ('@wangeditor-next/editor' and '@wangeditor-next/table-module') with the correct patch update designation. This format adheres to our expected changeset structure.


6-7: Descriptive Commit Message

The commit message "fix(table): allow parsing for TH elements in table module" clearly communicates the purpose of the change. It succinctly indicates the issue being addressed and aligns well with the PR objectives.


🪧 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. (Beta)
  • @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: 0

🧹 Nitpick comments (2)
packages/table-module/src/module/parse-style-html.ts (2)

31-35: Consider default border handling for TH elements.

The default border is only applied to TD elements. Consider whether TH elements should have similar default styling for consistency.

-  if (!border && elem.tagName === 'TD') {
+  if (!border && ['TD', 'TH'].includes(elem.tagName)) {
     // https://github.com/wangeditor-next/wangEditor-next/blob/master/packages/table-module/src/assets/index.less#L20
-    // TD存在默认的css样式,尝试用getComputedStyle获取不到,只能写死
+    // TD/TH存在默认的css样式,尝试用getComputedStyle获取不到,只能写死
     border = `1px solid ${DEFAULT_BORDER_COLOR}`
   }

1-4: Enhance function documentation.

The JSDoc should document which HTML elements are supported by this function.

 /**
  * @description parse style html
+ * @param {DOMElement} elem - The HTML element (TABLE, TD, or TH)
+ * @param {Descendant} node - The Slate node to update
+ * @param {IDomEditor} _editor - The editor instance
+ * @returns {Descendant} The updated node
  * @author hsuna
  */
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cc3bcbe and 2360160.

📒 Files selected for processing (1)
  • packages/table-module/src/module/parse-style-html.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test-e2e
  • GitHub Check: test
🔇 Additional comments (1)
packages/table-module/src/module/parse-style-html.ts (1)

17-17: LGTM! Clean implementation of TH support.

The change to use array includes is more maintainable and correctly implements TH element support.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant