refactor!: reorganize folder structure

[nanotaboada]

Summary by CodeRabbit

• Chores

  • Reorganized the project structure and updated configuration settings for dependency caching, workflow automation, and test references.
  • Refined ignore patterns to better exclude non-essential assets.

• Documentation

  • Updated startup commands and documentation references to align with the new project layout.

[coderabbitai]

Walkthrough

This pull request updates several configuration and solution files to reflect a reorganization of the project directory structure. The changes adjust file paths in CI workflows, launch configurations, solution entries, and project references to now use explicit src/ and test/ folders. Additionally, configuration files such as .codacy.yml, codecov.yml, and README.md have been refined with clearer comments, improved grouping of exclusions, adjusted ignore patterns, and updated asset references. There are no changes to the public API or exported entities.

Changes

Files	Change Summary
.codacy.yml	Refactored the exclude_paths section with grouped comments for clarity; removed exclusions for .github, .vscode, and .Tests directories; added exclusion for **/*.png files.
.github/workflows/dotnet.yml, .vscode/launch.json, Dotnet.Samples...sln, test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj	Updated file paths and project configurations to reflect the new directory structure—with source code now under src/ and tests under test/, including updates to dependency cache paths, launch configuration, solution project identifiers, and project reference locations.
README.md	Updated the command to start the project and the image reference for API documentation to align with the new src/ path and documentation location.
codecov.yml	Clarified configuration comments and expanded the ignore patterns to include additional project metadata, configuration files, and infrastructure/test folders.

Possibly related PRs

• chore(ci): update config for Dependabot lock file handling #181: Involved modifications to the .github/workflows/dotnet.yml file by adjusting dependency file paths, directly relating to the changes in this PR.
• chore(ci): simplify .NET CI workflow #177: Addressed updates to the CI workflow and directory structure for .NET setup, showing a strong code-level connection with the modifications in the current PR.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 97329a0 and c1f8ebc.

⛔ Files ignored due to path filters (3)

• Dotnet.Samples.AspNetCore.WebApi.Swagger.png is excluded by !**/*.png
• docs/Swagger.png is excluded by !**/*.png
• src/Dotnet.Samples.AspNetCore.WebApi/Data/players-sqlite3.db is excluded by !**/*.db

📒 Files selected for processing (7)

• .codacy.yml (1 hunks)
• .github/workflows/dotnet.yml (1 hunks)
• .vscode/launch.json (1 hunks)
• Dotnet.Samples.AspNetCore.WebApi.sln (1 hunks)
• README.md (2 hunks)
• codecov.yml (2 hunks)
• test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (13)

.codacy.yml (1)

1-30: Overall Configuration Enhancement Looks Great

The grouping of exclusions with clear, descriptive comments improves readability and maintainability. The new exclusion for **.png files is appropriately added to filter out image assets, aligning with the updated project structure.

.vscode/launch.json (1)

9-9: Updated Program Path Reflects New Directory Structure

The "program" path now correctly points to the DLL within the src/ folder, which aligns with the reorganized project layout. This update will help developers launch the application without path-related issues.

README.md (2)

24-25: Updated Project Start Command Correctly References New Location

The command to start the project has been updated to use the src/ directory (i.e. dotnet watch run --project src/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj), aligning it with the new folder structure.

---

33-33: Updated Image Reference for API Documentation

The image path for the API documentation has been revised to /docs/Swagger.png, which improves clarity and consistency with the new asset organization.

.github/workflows/dotnet.yml (1)

32-33: Cache Dependency Paths Updated Correctly

The updated cache-dependency-path entries now correctly point to the new locations for packages.lock.json in both the src and test directories, ensuring that dependency caching aligns with the reorganized structure.

test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj (1)

23-24: Project Reference Path Correctly Updated

The project reference has been updated to use ..\..\src\Dotnet.Samples.AspNetCore.WebApi\Dotnet.Samples.AspNetCore.WebApi.csproj, ensuring that the test project properly locates the main project file within the new src/ directory structure.

codecov.yml (4)

5-12: Improved coverage status configuration with clearer comments

The updated comments provide better clarity about the meaning of each configuration setting, particularly explaining the threshold as an "allowable drop in coverage" and specifying that CI failures should fail the coverage check.

---

14-14: Better documentation for component sections

The updated comment now clearly indicates that these are components for focused coverage metrics, improving understanding of this configuration section.

---

24-25: Clearer target specification for patch coverage

The comment now explicitly states that the target is for changed lines, making the purpose of this setting more evident.

---

29-52: Well-organized ignore patterns with clear categorization

The updated ignore section is much more comprehensive and well-structured with:

• Clear categorization by file type and purpose
• Descriptive comments for each section
• Appropriate patterns to ignore test, infrastructure, and support files

This organization will make future maintenance easier while ensuring accurate coverage metrics.

Dotnet.Samples.AspNetCore.WebApi.sln (3)

1-13: Well-structured solution with clear src/test separation

The reorganized solution file now properly follows the standard convention of separating source code and tests into dedicated folders. This structure improves project organization and maintainability.

---

32-35: Appropriate project nesting in solution folders

The NestedProjects section correctly organizes the projects under their respective logical folders, improving navigation in Visual Studio and other IDEs.

---

6-13:

✅ Verification successful

Verify project references in test project

Since the project paths have changed, ensure that the test project correctly references the main project with the updated path.

---

🏁 Script executed:

#!/bin/bash
# Check if the test project correctly references the main project with the updated path
cat test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj | grep -A 3 ProjectReference

Length of output: 269

---

Verified: Test project references are updated correctly.

The test project now correctly points to the main project using the relative path as verified:

• In test/Dotnet.Samples.AspNetCore.WebApi.Tests/Dotnet.Samples.AspNetCore.WebApi.Tests.csproj, the <ProjectReference> points to ..\..\src\Dotnet.Samples.AspNetCore.WebApi\Dotnet.Samples.AspNetCore.WebApi.csproj.

No further changes are needed.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[sonarqubecloud]

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
1.9% Duplication on New Code

See analysis details on SonarQube Cloud

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (97329a0)	1607	954	59.37%
Head commit (c1f8ebc)	1607 (+0)	954 (+0)	59.37% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#198)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.99%. Comparing base (97329a0) to head (c1f8ebc).
Report is 2 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff             @@
##            master     #198      +/-   ##
===========================================
- Coverage   100.00%   91.99%   -8.01%     
===========================================
  Files            2        4       +2     
  Lines          158      612     +454     
  Branches         9       70      +61     
===========================================
+ Hits           158      563     +405     
- Misses           0        7       +7     
- Partials         0       42      +42     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.