codecrafters-io / frontend

Rebuild complex systems from scratch
https://app.codecrafters.io/catalog
Other
64 stars 13 forks source link

Switch Admin Course Updates page to `CodeMirror` #2408

Closed VasylMarchuk closed 1 week ago

VasylMarchuk commented 1 week ago

Related to #1231

Brief

This switches the Admin Course Updates page to use CodeMirror instead of SyntaxHighlightedDiff, as well as adds support for CodeMirror to the FileDiffCard component.

Details

Screenshots

Знімок екрана 2024-11-19 о 14 26 57 Знімок екрана 2024-11-19 о 14 27 24

Checklist

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 1 week ago

Walkthrough

The changes in this pull request enhance the FileDiffCard component in an Ember application by introducing conditional rendering based on the @useCodeMirror property. If enabled, it utilizes a new CodeMirror component for displaying code diffs; otherwise, it retains the previous rendering logic. Additionally, a new controller and route for the FileDiffCard are created, allowing for dynamic interaction and navigation. Styling updates and a new template for the FileDiffCard are also included, along with modifications to the DiffBasedExampleDocument class to improve document handling.

Changes

File Change Summary
app/components/file-diff-card.hbs Modified rendering logic to conditionally use CodeMirror based on @useCodeMirror.
app/components/file-diff-card.ts Made code optional, added useCodeMirror, integrated dark mode functionality, and introduced a computed property for theme selection.
app/controllers/demo/file-diff-card.ts Introduced DemoFileDiffCardController to manage state and behavior for the file diff card, including tracked properties and actions.
app/router.ts Added a new route file-diff-card under the demo route.
app/routes/demo/file-diff-card.ts Created a new route class with query parameter handling for forceDarkTheme, selectedDocumentIndex, and useCodeMirror.
app/styles/app.css Added an import for course-admin-updates-diff.scss.
app/styles/pages/course-admin-updates-diff.scss Added a CSS rule for positioning collapsed lines in the CodeMirror component.
app/templates/course-admin/update.hbs Updated the main container div to include a new class and added @useCodeMirror={{true}} to the FileDiffCard component.
app/templates/demo.hbs Added a LinkTo component for navigation to the file-diff-card route.
app/templates/demo/file-diff-card.hbs Introduced a new template for rendering the FileDiffCard, including layout, options, and actions for user interaction.
app/utils/code-mirror-documents.ts Added a static method createEmpty to DiffBasedExampleDocument and updated the constructor for better diff parsing.

Possibly related issues

Possibly related PRs

Suggested labels

bug, dependencies

Suggested reviewers

🐰 In the meadow, changes bloom bright,
A FileDiffCard now shines with new light.
With CodeMirror to play, oh what a delight,
Dark themes and options, everything feels right!
Hop along, dear friends, let’s code with glee,
In this patch of wonder, come join me! 🌼✨


📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 39195ef6c68fedef83b0177465bc8fa33f063a72 and a0acaaa047836f8badf556d75786c477403e39b2.
📒 Files selected for processing (1) * `app/templates/demo/code-mirror.hbs` (2 hunks)
✅ Files skipped from review due to trivial changes (1) * app/templates/demo/code-mirror.hbs

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `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 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 1 week ago

Test Results

  1 files  ±0    1 suites  ±0   6m 42s ⏱️ +30s 583 tests ±0  543 ✅ ±0  40 💤 ±0  0 ❌ ±0  598 runs  ±0  558 ✅ ±0  40 💤 ±0  0 ❌ ±0 

Results for commit a0acaaa0. ± Comparison against base commit 801c4b2e.

:recycle: This comment has been updated with latest results.

codecov[bot] commented 1 week ago

Codecov Report

Attention: Patch coverage is 56.25000% with 7 lines in your changes missing coverage. Please review.

:white_check_mark: All tests successful. No failed tests found.

Files with missing lines Patch % Lines
app/controllers/demo/file-diff-card.ts 44.44% 5 Missing :warning:
app/components/file-diff-card.ts 0.00% 0 Missing and 1 partial :warning:
app/utils/code-mirror-documents.ts 0.00% 1 Missing :warning:
Additional details and impacted files

:loudspeaker: Thoughts on this report? Let us know!

codecov[bot] commented 1 week ago

Bundle Report

Changes will increase total bundle size by 6.83kB (0.02%) :arrow_up:. This is within the configured threshold :white_check_mark:

Detailed changes | Bundle name | Size | Change | | ----------- | ---- | ------ | | client-array-push | 35.85MB | 6.83kB (0.02%) :arrow_up: |
VasylMarchuk commented 1 week ago

Rebased to include latest @codemirror/merge from https://github.com/codecrafters-io/frontend/pull/2411