[workspace] show rich difference info on save #17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Review or Edit in CodeSandboxOpen the branch in Web Editor • VS Code • Insiders |
|
|
|
Your Render PR Server URL is https://pyth-on-line-pr-17.onrender.com. Follow its progress at https://dashboard.render.com/web/srv-cqjr7fdds78s73eqdu60. |
Reviewer's Guide by SourceryThis pull request enhances the workspace save functionality by introducing a new File-Level Changes
Tips
|
✅ Deploy Preview for pyth-on-line ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @CNSeniorious000 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| @@ -3,5 +3,5 @@ import type { PyProxy } from "pyodide/ffi"; | |||
| export class WorkspaceAPI extends PyProxy { | |||
| close(): void; | |||
| sync(sources: Record<string, string>, reload = true): void; | |||
| save(path: string, content: string, reload = true): void; | |||
| save(path: string, content: string, reload = true): string | void; | |||
There was a problem hiding this comment.
suggestion: Clarify the return type of save method.
The save method now returns string | void. It would be helpful to document under what conditions each type is returned to avoid confusion.
Suggested change
| save(path: string, content: string, reload = true): string | void; | |
| /** | |
| * Saves the content to the specified path. | |
| * | |
| * @param path - The path where the content should be saved. | |
| * @param content - The content to save. | |
| * @param reload - Whether to reload after saving. Defaults to true. | |
| * @returns A string message if an error occurs, otherwise void. | |
| */ | |
| save(path: string, content: string, reload = true): string | void; |
CNSeniorious000
changed the title
|
These styles are broken:
|
CNSeniorious000
force-pushed
the
save-show-diff
branch
from
c60019a
to
d114c3d
Compare
CNSeniorious000
force-pushed
the
main
branch
4 times, most recently
from
b1c4df1
to
5e5ee4f
Compare
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey @CNSeniorious000 - I've reviewed your changes and they look great!
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Enhance the workspace save functionality to provide rich difference information when saving files. Introduce a new diff function to compute text differences and update the Workspace.svelte component to display these differences in toast notifications. Adjust styling in CodeBlock.svelte and md.css for better text presentation.
New Features:
Enhancements: