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

(maint) Replace .editorconfig with nuget package #3488

Merged
merged 3 commits into from
Jul 29, 2024

Conversation

vexx32
Copy link
Member

@vexx32 vexx32 commented Jul 26, 2024

Description Of Changes

  • Remove editorconfig file
  • Add gitignore entry
  • Install nuget package for the editorconfig file/best practices

Motivation and Context

In order for us to have a consistent baseline for code style, we've pulled our standards out into a Chocolatey.BestPractice nuget package, which is being brought in to here.

Testing

  1. Build the project in VS to populate the nuget package and files
  2. Verify the editorconfig rules are still being applied by adding or modifying code to cause a violation. (for example, I tested these rules are still in effect by adding a single-line if statement without braces and checking VS's error list to ensure the IDE0011 style rule is flagged as it should be with our editorconfig settings.

Operating Systems Testing

N/A

Change Types Made

  • Bug fix (non-breaking change).
  • Feature / Enhancement (non-breaking change).
  • Breaking change (fix or feature that could cause existing functionality to change).
  • Documentation changes.
  • PowerShell code changes.

Change Checklist

  • Requires a change to the documentation.
  • Documentation has been updated.
  • Tests to cover my changes, have been added.
  • All new and existing tests passed?
  • PowerShell code changes: PowerShell v3 compatibility checked?

Related Issue

N/A

We'll be replacing it with an editorconfig from a nuget package, but
need to remove the individual one here first.
So we don't accidentally commit an editorconfig file that's being
maintained by the nuget package.
This replaces the editorconfig file removed in earlier commits.
@vexx32 vexx32 requested a review from a team as a code owner July 26, 2024 20:51
@vexx32 vexx32 requested a review from gep13 July 26, 2024 20:51
Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

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

LGTM!

@gep13 gep13 merged commit 0487213 into chocolatey:develop Jul 29, 2024
5 checks passed
@gep13
Copy link
Member

gep13 commented Jul 29, 2024

@vexx32 thank you for getting this added!

@vexx32 vexx32 deleted the editorconfig-nuget-package branch July 29, 2024 12:58
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.

2 participants