-
-
Notifications
You must be signed in to change notification settings - Fork 11
fix: save text after format #90
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @unvalley, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request resolves an issue where text formatting operations were not fully persisted or correctly registered within the application's state and the CodeMirror editor. It ensures that formatted content is saved, propagated to relevant components, and treated as a user-initiated change by the editor.
Highlights
- Content Persistence: Ensures that the editor's content state and character count are updated with the newly formatted text, and external onChange listeners are notified.
- Editor Event Handling: Marks the application of formatted text within the CodeMirror editor as a user input event, which is crucial for proper undo/redo behavior and other editor functionalities.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Deploying ephe with
|
| Latest commit: |
2333812
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fbaf97c9.ephe.pages.dev |
| Branch Preview URL: | https://fix-save-after-format.ephe.pages.dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request fixes an issue where formatted text was not being saved. The fix is implemented in two places: the onFormat function (for the Mod-S shortcut) and the handleFormatDocument function (for the command menu).
While the fix works, it's implemented differently in each location. In command-menu.tsx, you've used CodeMirror's annotations to trigger an update, which is a clean approach that reuses existing logic. However, in use-markdown-editor.ts, you've added manual state update logic. My main feedback is to use the annotations approach in both places for consistency and to avoid duplicating state update logic.
Additionally, I've noticed that the entire formatting logic is duplicated between use-markdown-editor.ts and command-menu.tsx. I've left a suggestion to refactor this to improve maintainability.
| view.dispatch({ | ||
| changes: { from: 0, to: state.doc.length, insert: formattedText }, | ||
| }); | ||
| // Persist formatted content to state/storage and notify listeners | ||
| setContent((prevContent) => (prevContent !== formattedText ? formattedText : prevContent)); | ||
| if (onChange) { | ||
| onChange(formattedText); | ||
| } | ||
| setCharCount(formattedText.length); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR introduces two different strategies to fix the issue of formatted text not being saved. In command-menu.tsx, you've used annotations: Transaction.userEvent.of("input") to mark the change as user input, which allows the existing EditorView.updateListener to handle saving the content. This is a clean approach that reuses existing logic.
To maintain consistency and avoid duplicating state update logic, I suggest applying the same strategy here in onFormat. This will centralize the content update logic within the updateListener.
You can replace the view.dispatch call and the subsequent state update logic with a single dispatch that includes the annotation. You'll also need to add Transaction to the import from @codemirror/state at the top of the file.
| view.dispatch({ | |
| changes: { from: 0, to: state.doc.length, insert: formattedText }, | |
| }); | |
| // Persist formatted content to state/storage and notify listeners | |
| setContent((prevContent) => (prevContent !== formattedText ? formattedText : prevContent)); | |
| if (onChange) { | |
| onChange(formattedText); | |
| } | |
| setCharCount(formattedText.length); | |
| view.dispatch({ | |
| changes: { from: 0, to: state.doc.length, insert: formattedText }, | |
| annotations: Transaction.userEvent.of("input"), | |
| }); |
No description provided.