Skip to content

feat: add first version #18

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

Closed
wants to merge 1 commit into from
Closed

feat: add first version #18

wants to merge 1 commit into from

Conversation

TimKingNF
Copy link

@TimKingNF TimKingNF commented Jun 29, 2025

Summary 🎯

first version

Changes 🔁

  • add subrem-count-widget for counting focus rem

Summary by CodeRabbit

  • New Features
    • Introduced a floating widget that displays the number of children Rems for the currently focused Rem.
    • The widget automatically appears near the editor caret when a Rem with children is focused.
  • Improvements
    • Updated plugin metadata and documentation for clarity and accuracy.
    • Added a new dependency to enhance styling capabilities.
  • Removals
    • Removed the previous sample widget and related settings functionality.

Copy link

coderabbitai bot commented Jun 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The project introduces a new floating widget for RemNote that displays the count of child Rems for the currently focused Rem. This is achieved by updating the widget registration logic, adding a new widget component, updating project metadata, and revising documentation and dependencies.

Changes

File(s) Change Summary
README.md Added a new README with a brief project description.
package.json Updated scripts to use npx and added the clsx dependency.
public/manifest.json Updated plugin metadata: name, author, ID, description, repo URL, and removed the theme field.
src/widgets/index.tsx Replaced sidebar widget logic with floating widget logic; added focus event handling.
src/widgets/sample_widget.tsx Removed the old sample widget component and its registration.
src/widgets/subrem-count-widget.tsx Added a new widget component to display the count of child Rems for the focused Rem.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RemNote Editor
    participant Plugin (onActivate)
    participant SubRemCountWidget

    User->>RemNote Editor: Focuses on a Rem
    RemNote Editor->>Plugin (onActivate): Emits FocusedRemChange event
    Plugin (onActivate)->>RemNote Editor: Fetch focused Rem and its children
    alt If Rem has children and widget not open
        Plugin (onActivate)->>SubRemCountWidget: Open floating widget near caret
        SubRemCountWidget->>RemNote Editor: Fetch children count
        SubRemCountWidget-->>User: Display count of child Rems
    else If Rem has no children or widget already open
        Plugin (onActivate)-->>RemNote Editor: Do nothing
    end
Loading

Poem

In the land of Rems where subtrees sprout,
A widget now counts what’s hidden about.
With every focus, a number appears—
Children Rems tallied, dispelling your fears.
Scripts updated, old widgets out,
🐇 Cheers for the count—let’s hop and shout!


📜 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 a9c1590 and 2b10875.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (6)
  • README.md (1 hunks)
  • package.json (1 hunks)
  • public/manifest.json (1 hunks)
  • src/widgets/index.tsx (1 hunks)
  • src/widgets/sample_widget.tsx (0 hunks)
  • src/widgets/subrem-count-widget.tsx (1 hunks)
✨ 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.

@TimKingNF TimKingNF closed this Jun 29, 2025
@TimKingNF TimKingNF deleted the dev branch June 29, 2025 12:00
@TimKingNF TimKingNF restored the dev branch June 29, 2025 12:15
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.

1 participant