Halleck45 / ast-metrics

AST Metrics is a language-agnostic static code analyzer.
https://halleck45.github.io/ast-metrics/
MIT License
59 stars 5 forks source link

Add dark mode switcher feature #54

Closed Halleck45 closed 2 months ago

Halleck45 commented 3 months ago

Related to #52

Adds a dark mode switcher to the application to improve readability and user experience.


For more details, open the Copilot Workspace session.

coderabbitai[bot] commented 3 months ago

Walkthrough

The layout.html file has been updated to enhance user interaction and experience. The main changes include modifying the SVG path for the GitHub link to ensure it displays correctly, adding functionality for a dark mode switcher, and updating JavaScript to manage dark mode preferences using localStorage.

Changes

File Path Change Summary
src/…/layout.html Updated SVG path data for GitHub link, added dark mode switcher, and included JavaScript for toggling dark mode based on localStorage.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant HTML_File as layout.html

    User->>Browser: Visits the page
    Browser->>HTML_File: Loads layout.html
    HTML_File->>Browser: Displays GitHub link with updated SVG
    User->>Browser: Toggles dark mode switch
    Browser->>HTML_File: Executing dark mode JavaScript
    HTML_File->>localStorage: Store user preference for dark mode
    Browser->>HTML_File: Apply dark mode based on user preference

Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between e7c67d273d7d8a95ad0eabc60243f829c27e896b and 2ed36a598fc453185207da801540b2c817b203f3.
Files selected for processing (1) * src/Report/Html/templates/layout.html (5 hunks)
Additional comments not posted (2)
src/Report/Html/templates/layout.html (2)
`79-80`: The updated SVG path for the GitHub icon looks correct. Ensure that the visual representation meets the design specifications. --- `146-182`: The JavaScript for managing the dark mode is robust, handling both the enabling and disabling of the theme, as well as persisting the user's preference in local storage. Ensure to test across different browsers to confirm the consistency of local storage behavior.
--- 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 .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 55.12%. Comparing base (e7c67d2) to head (2ed36a5).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #54 +/- ## ======================================= Coverage 55.12% 55.12% ======================================= Files 41 41 Lines 3334 3334 ======================================= Hits 1838 1838 Misses 1279 1279 Partials 217 217 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.