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

Align .editorconfig with dotnet new template #289

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

MattKotsenas
Copy link
Collaborator

@MattKotsenas MattKotsenas commented Dec 19, 2024

Align .editorconfig with the updated dotnet new template.

The effect of this change is to set 2-space indent for *.json. That's important to make the code review bots stop complaining about indentation.

Summary by CodeRabbit

  • Chores
    • Updated indentation settings for XML and JSON files to improve consistency.
    • Improved formatting of JSON files for better readability without altering content.

Copy link

coderabbitai bot commented Dec 19, 2024

📝 Walkthrough

Walkthrough

The pull request introduces refined indentation settings in the .editorconfig file, specifically targeting XML and JSON file types. The changes focus on standardizing the indentation to 2 spaces for various XML-related files, including XML project files, config files, and general XML files. Additionally, the JSON file formatting has been updated, with minor adjustments to whitespace in baseline.json and stylecop.json to improve consistency and readability.

Changes

File Change Summary
.editorconfig Updated indentation settings to 2 spaces for XML files, XML project files, XML config files, and JSON files
build/perf/baseline.json Removed leading whitespace before closing brace
build/targets/codeanalysis/stylecop.json Adjusted indentation to use consistent spaces

Possibly related PRs

Suggested labels

dependencies, releasable

Suggested reviewers

  • rjmurillo

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c6e7c79 and 3fd7060.

📒 Files selected for processing (3)
  • .editorconfig (1 hunks)
  • build/perf/baseline.json (1 hunks)
  • build/targets/codeanalysis/stylecop.json (1 hunks)
🔇 Additional comments (4)
build/perf/baseline.json (1)

2-5: LGTM! Formatting aligns with the new .editorconfig rules

The JSON structure is properly formatted with 2-space indentation as specified in the updated .editorconfig.

build/targets/codeanalysis/stylecop.json (1)

2-11: LGTM! Formatting aligns with the new .editorconfig rules

The JSON structure is properly formatted with consistent 2-space indentation as specified in the updated .editorconfig.

.editorconfig (2)

19-20: LGTM! JSON indentation rule matches PR objective

The JSON file indentation rule is properly set to 2 spaces, which:

  1. Aligns with the PR objective
  2. Matches the formatting in baseline.json and stylecop.json

8-18: LGTM! XML file indentation rules are properly categorized

The changes properly separate and standardize indentation rules for different types of XML files:

  • General XML files
  • XML project files
  • XML config files

Each category is correctly set to use 2-space indentation, which aligns with the dotnet new template standards.

✅ Verification successful

XML indentation standardization is appropriate for the repository's needs

The repository contains numerous XML-based files (.props, .targets, .csproj, .nuspec) that will benefit from consistent 2-space indentation rules. The standardization is particularly relevant given the extensive use of MSBuild files in the build configuration structure and project files.

  • Found 26 XML-based files that will be affected by these rules
  • Heavily used in build configuration: build/targets/*/ contains multiple .props and .targets files
  • Applied to project files: multiple .csproj files across src/ and tests/ directories
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify that these settings match dotnet new template defaults
dotnet new --list | grep "Template Name"

Length of output: 139


Script:

#!/bin/bash
# Let's check if there are any other .editorconfig files in the repository
# and verify the consistency of XML indentation rules
fd -e editorconfig -x cat {}

# Also check if there are any XML files to verify the impact
fd -e xml -e csproj -e fsproj -e vbproj -e proj -e props -e targets -e config -e nuspec

Length of output: 1194


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>, 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. (Beta)
  • @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.

Copy link

codeclimate bot commented Dec 19, 2024

Code Climate has analyzed commit 3fd7060 and detected 0 issues on this pull request.

View more on Code Climate.

Copy link
Owner

@rjmurillo rjmurillo left a comment

Choose a reason for hiding this comment

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

Thanks!

@rjmurillo rjmurillo merged commit 7b3855c into rjmurillo:main Dec 19, 2024
9 checks passed
@rjmurillo rjmurillo added this to the vNext milestone Dec 19, 2024
@MattKotsenas MattKotsenas deleted the bugfix/editorconfig-json branch December 19, 2024 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants