Add Item 16: Do not call overridable methods in constructors

[rjmurillo]

Update .globalconfig to enable CA2214 with Warning severity

Closes #59

[coderabbitai]

Walkthrough

The pull request introduces a new diagnostic rule to the General.globalconfig file, specifically addressing the guideline against calling overridable methods in constructors (CA2214). The severity for this rule is set to warning. Additionally, minor formatting adjustments have been made, and comments regarding the handling of global_level in .NET versions 5 and 6+ have been clarified. The existing rule related to implementing the standard Dispose pattern (CA1063) remains unchanged.

Changes

Files	Change Summary
src/EffectiveCSharp.Analyzers/Build/Config/General.globalconfig	Added new diagnostic rule CA2214 with severity set to warning; minor formatting adjustments; clarified comments on global_level.

Assessment against linked issues

Objective	Addressed	Explanation
Item 16: Never call virtual functions in constructors ( #59 )	✅

Possibly related PRs

• Add Item 17: update configuration to enable CA1063 as warning #67: This PR involves modifications to the General.globalconfig file, specifically adding a diagnostic rule for CA1063, which is related to the existing changes for CA2214 in the main PR.

---

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
• 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 resolve resolve all the CodeRabbit review comments.
• @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.

[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 (9144e7c)	1250	1093	87.44%
Head commit (ebb0d61)	1250 (+0)	1093 (+0)	87.44% (+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 (#68)	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

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

📥 Commits

Files that changed from the base of the PR and between 9144e7c and ebb0d61.

📒 Files selected for processing (1)

• src/EffectiveCSharp.Analyzers/Build/Config/General.globalconfig (2 hunks)

🔇 Additional comments (3)

src/EffectiveCSharp.Analyzers/Build/Config/General.globalconfig (3)

4-7: Improved clarity on global_level behavior in .NET 6+

The updated comment provides valuable information on how conflicting entries are handled in .NET 6+. This clarification is crucial for developers to understand the precedence rules when working with multiple configuration files.

---

56-56: Improved formatting

The addition of a newline before the CA1063 rule improves readability and maintains consistency with the formatting of other rules in the file.

---

Line range hint 1-56: Summary of changes

The changes in this file successfully implement the main objective of the PR by adding the CA2214 rule to prevent calling overridable methods in constructors. Additionally, the updates improve clarity on global_level behavior and enhance overall formatting.

These modifications align well with the PR objectives and address the concerns raised in issue #59. The implementation enforces best practices in C# programming, particularly regarding constructor behavior in object-oriented programming.