Skip to content
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

feat: add more sonar exclusions #196

Merged
merged 1 commit into from
Mar 5, 2024
Merged

Conversation

alichherawalla
Copy link
Contributor

@alichherawalla alichherawalla commented Mar 5, 2024

Ticket Link


Related Links


Description


Steps to Reproduce / Test



Checklist

  • PR description included
  • yarn test passes
  • Tests are [changed or added]
  • Relevant documentation is changed or added (and PR referenced)

GIF's


Live Link


Summary by CodeRabbit

  • Chores
    • Updated SonarQube analysis exclusion patterns to improve code quality metrics by excluding specific test-related files and patterns.

Copy link
Contributor

coderabbitai bot commented Mar 5, 2024

Walkthrough

This update focuses on refining the SonarQube analysis process by adjusting the exclusion patterns specified in the sonar-project.properties file. The modifications aim to omit certain test-related files and other specific patterns within the project, enhancing the efficiency and relevance of the analysis by focusing on pertinent code components.

Changes

File Path Change Summary
sonar-project.properties Updated exclusion patterns to exclude test-related files and specific patterns

🐇✨

In the realm of code where the bits align,
A rabbit hopped through, making changes so fine.
Exclusions set, the clutter cast aside,
For cleaner analysis, we now abide.
Hop, skip, jump, in the digital glade,
With each smart tweak, better software is made.
🌟🐾

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0a93ba7 and a0fb14f.
Files selected for processing (1)
  • sonar-project.properties (1 hunks)

@@ -4,7 +4,7 @@ sonar.projectKey=wednesday-solutions_react-template_AY4NDr6dB2n8RRmGoUim
sonar.language=js
sonar.sources=.
sonar.tests=app
sonar.exclusions=**/storybook/**/*.*,**/internals/**/*.*,**/server/**/*.*
sonar.exclusions=**/tests/**/*.*,**/storybook/**/*.*,**/internals/**/*.*,**/server/**/*.*,app/**/*.test.{js,jsx},app/*/RbGenerated*/*.{js,jsx},app/app.js,app/components/ScrollToTop/*.js,app/components/ErrorBoundary/*.js,app/global-styles.js,app/*/*/loadable.{js,jsx},**/loadable.js,**/apiUtils.js,**/testUtils.js,**/stories/**,**/themes/index.js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The updated exclusion patterns in the sonar-project.properties file are comprehensive, covering a wide range of files and directories that are typically not critical for code quality analysis, such as tests, storybook configurations, internals, server-side code, and specific React components and utilities. This aligns well with the PR's objective to refine the scope of SonarQube's analysis by excluding non-critical parts of the codebase.

However, it's important to ensure that all patterns added are indeed not relevant for the quality analysis you wish to perform. For instance, excluding entire directories like **/internals/**/*.* and **/server/**/*.* might be too broad if there are pieces of code within those directories that should be subject to quality checks. It's recommended to review these patterns and ensure they accurately reflect the project's structure and analysis needs.

Additionally, consider documenting the rationale behind each exclusion pattern within the project's documentation or directly in the sonar-project.properties file as comments. This will help maintain the configuration over time, making it easier for future contributors to understand the reasoning behind each exclusion.

Consider reviewing and refining the exclusion patterns to ensure they accurately reflect the project's needs. Additionally, documenting the rationale behind each pattern can improve maintainability.

Copy link

github-actions bot commented Mar 5, 2024

Jest Coverage Report

Total coverage

Status Category Percentage Covered / Total
🟢 Statements 98.62% 357/362
🟢 Branches 95.76% 113/118
🟢 Functions 98.31% 116/118
🟢 Lines 98.73% 310/314

Status of coverage: 🟢 - ok, 🟡 - slightly more than threshold, 🔴 - under the threshold

Report generated by 🧪jest coverage report action from a0fb14f

Copy link

sonarqube-ws bot commented Mar 5, 2024

Passed

Analysis Details

0 Issues

  • Bug 0 Bugs
  • Vulnerability 0 Vulnerabilities
  • Code Smell 0 Code Smells

Coverage and Duplications

  • Coverage No coverage information (98.20% Estimated after merge)
  • Duplications No duplication information (0.00% Estimated after merge)

Project ID: wednesday-solutions_react-template_AY4NDr6dB2n8RRmGoUim

View in SonarQube

@alichherawalla alichherawalla merged commit 3bb5362 into master Mar 5, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant