-
Notifications
You must be signed in to change notification settings - Fork 92
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
Conversation
WalkthroughThis update focuses on refining the SonarQube analysis process by adjusting the exclusion patterns specified in the Changes
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@@ -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 |
There was a problem hiding this comment.
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.
Jest Coverage ReportTotal coverage
Report generated by 🧪jest coverage report action from a0fb14f |
Ticket Link
Related Links
Description
Steps to Reproduce / Test
Checklist
yarn test
passesGIF's
Live Link
Summary by CodeRabbit