search

azimuttapp / azimutt

Explore, document and optimize any database
https://azimutt.app
MIT License
1.36k stars 87 forks source link

feat: html report #307

Closed tonylyjones closed 5 months ago

tonylyjones commented 5 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

This update introduces new React components for a report management application. The main structure involves an App component managing selected rule levels, categories, rules, and tables using context. Child components like MainLayout, ReportFilters, and ViolationsList are provided data through context, enhancing modularity and state management. New components like Logo, AppBar, ReportStats, and MultiSelect were added to handle specific UI features, improving the overall user experience.

Changes

Files Change Summary
cli/html-report/src/App.tsx Introduces App component for managing state related to rule levels, categories, rules, and tables.
cli/html-report/src/components/azimutt/Logo/Logo.tsx Adds Logo component to render an image with a specified class name, displaying the logo of the application.
cli/html-report/src/components/layout/AppBar/AppBar.tsx Introduces AppBar component displaying a logo linking to the homepage.
cli/html-report/src/components/report/ReportStats/ReportStats.tsx Introduces ReportStats component to render various report statistics using context data.
cli/.../components/ui/multi-select.tsx Adds MultiSelect component for selecting multiple options from a list with advanced interactive features.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant ReportContext
    participant MainLayout
    participant ReportFilters
    participant ViolationsList

    User->>App: Access Report Page
    App->>ReportContext: Initialize Context
    App->>MainLayout: Render Layout
    App->>ReportFilters: Provide Filters
    App->>ViolationsList: List Violations
    User->>ReportFilters: Select Filters
    ReportFilters->>ReportContext: Update Filters
    ReportContext->>ViolationsList: Update Violation List
    ViolationsList->>User: Display Updated Violations

Poem

In the world of React, changes bloom,
With components bright, dispelling gloom.
The App takes charge, through context it shares,
Filters and stats in layers and pairs.
Selecting rules, categories, all,
A seamless dance, at your call.
Cheers to the code, from bunny and friends,
A path of UI elegance never ends! 🐇✨

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.