Skip to content

Conversation

@z0gSh1u
Copy link
Contributor

@z0gSh1u z0gSh1u commented Aug 15, 2025

@sourcery-ai
Copy link

sourcery-ai bot commented Aug 15, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updated DOM traversal to include Text nodes in the TreeWalker and extended grabNode to handle Text instances by mapping them to their nearest translatable parent element.

Class diagram for updated grabNode and TreeWalker usage

classDiagram
    class TreeWalker {
        +nextNode(): Node
    }
    class Text {
    }
    class Element {
        +tagName: string
    }
    class grabNode {
        +grabNode(node: Element | Text): Element | false
    }
    class findTranslatableParent {
        +findTranslatableParent(node: Text): Element | null
    }
    TreeWalker --> Text
    TreeWalker --> Element
    grabNode --> Element
    grabNode --> Text
    grabNode --> findTranslatableParent
    findTranslatableParent --> Element
    findTranslatableParent --> Text
Loading

File-Level Changes

Change Details Files
Include Text nodes in TreeWalker traversal
  • Add NodeFilter.SHOW_TEXT flag to the TreeWalker instantiation
  • Update acceptNode callback to FILTER_ACCEPT Text nodes
entrypoints/main/dom.ts
Allow grabAllNode to handle Text nodes
  • Cast currentNode to Element
Text when calling grabNode
Extend grabNode to process Text nodes
  • Add early return for null nodes before tagName checks
  • Introduce a branch for Text instances that calls findTranslatableParent
  • Return the parent element for translatable Text nodes or false otherwise
entrypoints/main/dom.ts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes - here's some feedback:

  • Filter out empty or whitespace-only Text nodes in the TreeWalker acceptNode to reduce unnecessary processing.
  • Update grabNode’s parameter and return types from any to more precise Node and Element|false to improve type safety.
  • After resolving a Text node to a parent element, re-apply the element tag filters before accepting it to avoid including non-translatable parents.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Filter out empty or whitespace-only Text nodes in the TreeWalker acceptNode to reduce unnecessary processing.
- Update grabNode’s parameter and return types from any to more precise Node and Element|false to improve type safety.
- After resolving a Text node to a parent element, re-apply the element tag filters before accepting it to avoid including non-translatable parents.

## Individual Comments

### Comment 1
<location> `entrypoints/main/dom.ts:36` </location>
<code_context>
+        NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT,
         {
             acceptNode: (node: Node): number => {
+                if (node instanceof Text) return NodeFilter.FILTER_ACCEPT;
+
                 if (!(node instanceof Element)) return NodeFilter.FILTER_SKIP;
</code_context>

<issue_to_address>
Accepting Text nodes may lead to duplicate or unexpected parent node selection.

Ensure grabNode prevents adding the same parent node multiple times when processing multiple child Text nodes. Consider if deduplication is required to avoid duplicate entries in the result array.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

NodeFilter.SHOW_ELEMENT | NodeFilter.SHOW_TEXT,
{
acceptNode: (node: Node): number => {
if (node instanceof Text) return NodeFilter.FILTER_ACCEPT;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (bug_risk): Accepting Text nodes may lead to duplicate or unexpected parent node selection.

Ensure grabNode prevents adding the same parent node multiple times when processing multiple child Text nodes. Consider if deduplication is required to avoid duplicate entries in the result array.

@Bistutu Bistutu merged commit 6d6dfbc into Bistutu:main Aug 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants