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

Embed selected rule in the url when sharing. #65

Merged
merged 2 commits into from
Sep 12, 2024

Conversation

omer-biz
Copy link
Contributor

@omer-biz omer-biz commented Sep 7, 2024

This PR resolves this issue #61

Summary by CodeRabbit

  • New Features
    • Enhanced sharing functionality to include the last selected rule, improving context when sharing data.
    • Implemented local storage support to remember user preferences for the last selected rule across sessions.

Copy link

coderabbitai bot commented Sep 7, 2024

Walkthrough

The changes introduce enhancements to the tryLoadFromShareLink and shareData functions in the static/scripts/shareButton.ts file. The tryLoadFromShareLink function now saves the selectedRule to local storage, while the shareData function retrieves this value for inclusion when sharing data. These modifications enable the application to remember user selections and provide relevant context during data sharing.

Changes

Files Change Summary
static/scripts/shareButton.ts Enhanced tryLoadFromShareLink to store selectedRule in local storage; modified shareData to retrieve last-selected-rule from local storage for sharing.

Poem

In a world where choices bloom,
A rabbit hops, dispelling gloom.
With rules remembered, oh what cheer,
Sharing joy, both far and near!
Let's celebrate this lovely day,
With every hop, we'll find our way! 🐇✨


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7b971e9 and 08058c4.

Files selected for processing (1)
  • static/scripts/shareButton.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • static/scripts/shareButton.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 391d5e5 and 7b971e9.

Files selected for processing (1)
  • static/scripts/shareButton.ts (2 hunks)
Additional comments not posted (1)
static/scripts/shareButton.ts (1)

58-58: Good use of fallback for selectedRule.

The implementation to include the selectedRule in the shared data with a fallback to an empty string is a robust approach. This ensures that the function can handle cases where no rule is selected without causing errors.

@@ -45,6 +45,7 @@ function tryLoadFromShareLink(codeMirror) {
"textarea.editor-input-text",
)!;
inputEditor.value = decoded["input"];
localStorage.setItem("last-selected-rule", decoded["selectedRule"]);
Copy link

@coderabbitai coderabbitai bot Sep 7, 2024

Choose a reason for hiding this comment

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

Add a check for selectedRule before storing.

The change to store the selectedRule in local storage is aligned with the PR's objectives. However, it's important to ensure that selectedRule is present in the decoded data before attempting to store it. This can prevent potential issues with undefined values being set in local storage.

Consider adding a check like this:

- localStorage.setItem("last-selected-rule", decoded["selectedRule"]);
+ if (decoded["selectedRule"]) {
+   localStorage.setItem("last-selected-rule", decoded["selectedRule"]);
+ }
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
localStorage.setItem("last-selected-rule", decoded["selectedRule"]);
if (decoded["selectedRule"]) {
localStorage.setItem("last-selected-rule", decoded["selectedRule"]);
}

Copy link
Contributor

Choose a reason for hiding this comment

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

This is a reasonable suggestion 👍

Copy link

Choose a reason for hiding this comment

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

@nathanielknight Thanks for the confirmation! 😊

@nathanielknight
Copy link
Contributor

I think the coderrabbitai review makes a good suggestion: we don't want to be setting undefined values in local storage.

Other than that, this looks solid 👍

@tomtau tomtau merged commit 767eaac into pest-parser:master Sep 12, 2024
3 checks passed
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.

3 participants