Add .editorconfig by iSazonov · Pull Request #7357 · PowerShell/PowerShell · GitHub

PR Summary

Related #4708.

The .editorconfig file can be used by various editors and tools like Visual Studio and CodeFormatter.

The .editorconfig comes from Roslyn and CoreFX repositories:
https://github.com/dotnet/corefx/blob/master/.editorconfig
https://github.com/dotnet/roslyn/blob/master/.editorconfig

Description http://EditorConfig.org

Options https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
Change is not breaking
Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
This PR is ready to merge and is not Work in Progress.
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready.
User-facing changes
- Not Applicable
- OR
- User-facing Documentation needed
  - Issue filed - Issue link:
Testing - New and feature
- Not Applicable or can only be tested interactively
- OR
- Make sure you've added a new test if existing tests do not effectively test the code changed
  - Add [feature] if the change is significant or affects feature tests

This isn't in our style: https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/coding-guidelines.md

Could you please clarify? We have in the guideline:

Use _camelCase to name internal and private fields and use readonly where possible.

I must have misread the guidance. Resolved

some of these conflict with style cop rules. It would be good to make them consistent (disable the conflicting rules)

I believe we have already gained experience with StyleCop and we can turn off a few more rules. But first I would like to make some PR with CodeFormatting and style fixes so that we see the state of things more clearly. Also I guess CodeFormatter will use the .editorconfig file.

Many of the naming rules, especially for non-public fields, conflict with the style cop rules. I believe those rules should be disabled before we add a file that defines conflicting rules.

This PR has been automatically marked as stale because it has not had activity in the last 30 days. It will be closed if no further activity occurs within 10 days.
Thank you for your contributions.
Community members are welcome to grab these works.

Steve Lee (@SteveL-MSFT) Could you please share plans about fixing style issues?
My suggetion is to spend 1-2 weeks and fix as many style issues as we need, adjust and approve StyleCop and .editorconfig rules, reformat all code with CodeFormatter. After that we can return to normal contributing process with minimal style issue pressure.

Ilya (@iSazonov) I think after GA of 6.1 would be the best time to bulk address style issues to have consistency. We're still targeting mid Sept for GA, so perhaps we can postpone this until then.

Steve Lee (@SteveL-MSFT) GA shipped; it's time to look at this. :)

The .editorconfig comes from Roslyn and CoreFX repositories: https://github.com/dotnet/corefx/blob/master/.editorconfig https://github.com/dotnet/roslyn/blob/master/.editorconfig

Rebased to update CIs.

We don't have any vb code, but we do have cpp.

Fixed.

what about ps1xml files? Should we remove extensions we don't use in this repo?

Added resx,ps1xml. Removed unused.

Travis Plunk (@TravisEz13) Can we merge? Or we should address

some of these conflict with style cop rules. It would be good to make them consistent (disable the conflicting rules)

If .editorconfig rules is ok we could continue with style cop rules in follow PRs.

Enable support for EditorConfig in OmniSharp. Since omnisharp-roslyn version 1.33.0, OmniSharp has had this support. * https://github.com/OmniSharp/omnisharp-roslyn/blob/master/CHANGELOG.md#1330---2019-07-01 * PowerShell#7357 * OmniSharp/omnisharp-roslyn#1526

Related PowerShell#4708. The .editorconfig file can be used by various editors and tools like Visual Studio and CodeFormatter. The .editorconfig comes from Roslyn and CoreFX repositories: https://github.com/dotnet/corefx/blob/master/.editorconfig https://github.com/dotnet/roslyn/blob/master/.editorconfig Description http://EditorConfig.org Options https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference

Ilya (iSazonov) self-assigned this Jul 25, 2018

Ilya (iSazonov) requested review from Steve Lee (SteveL-MSFT), Travis Plunk (TravisEz13), Aditya Patwardhan (adityapatwardhan) and Dongbo Wang (daxian-dbw) July 25, 2018 11:42

Travis Plunk (TravisEz13) reviewed Jul 27, 2018

View reviewed changes

stale Bot added the Stale label Aug 29, 2018

stale Bot removed the Stale label Aug 30, 2018

Add .editorconfig

54c0de2

The .editorconfig comes from Roslyn and CoreFX repositories: https://github.com/dotnet/corefx/blob/master/.editorconfig https://github.com/dotnet/roslyn/blob/master/.editorconfig

Ilya (iSazonov) force-pushed the add-editorconfig branch from bda45b9 to 54c0de2 Compare September 19, 2018 08:07

Steve Lee (SteveL-MSFT) requested changes Sep 24, 2018

View reviewed changes

Address feedback about extensions

282619e

Steve Lee (SteveL-MSFT) approved these changes Sep 26, 2018

View reviewed changes

Travis Plunk (TravisEz13) merged commit 3b9f758 into PowerShell:master Oct 1, 2018

Ilya (iSazonov) deleted the add-editorconfig branch October 2, 2018 03:16

xtqqczze mentioned this pull request Jan 19, 2020

vscode: Enable EditorConfig support in OmniSharp #11627

Merged

8 tasks

xtqqczze mentioned this pull request Jun 2, 2020

Add missing .editorconfig settings present in dotnet/runtime #12871

Merged

14 tasks

+              # (Please don't specify an indent_size here; that has too many unintended consequences.)
+              # Code files
+              [*.{cs,csx,vb,vbx}]

+              charset = utf-8
+              # Xml project files
+              [*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]

Add .editorconfig by iSazonov · Pull Request #7357 · PowerShell/PowerShell · GitHub

Uh oh!

Add .editorconfig - #7357

Add .editorconfig#7357Travis Plunk (TravisEz13) merged 2 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom iSazonov:add-editorconfigiSazonov/PowerShell:add-editorconfigCopy head branch name to clipboard

Conversation

Ilya (iSazonov) commented Jul 25, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Travis Plunk (TravisEz13) Jul 27, 2018

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) Jul 30, 2018

Choose a reason for hiding this comment

Uh oh!

Travis Plunk (TravisEz13) Jul 30, 2018

Choose a reason for hiding this comment

Uh oh!

Travis Plunk (TravisEz13) commented Jul 27, 2018

Uh oh!

Ilya (iSazonov) commented Jul 30, 2018

Uh oh!

Travis Plunk (TravisEz13) commented Jul 30, 2018

Uh oh!

stale Bot commented Aug 29, 2018

Uh oh!

Ilya (iSazonov) commented Aug 30, 2018

Uh oh!

Steve Lee (SteveL-MSFT) commented Aug 31, 2018

Uh oh!

Andrew (anmenaga) commented Sep 18, 2018

Uh oh!

Ilya (iSazonov) commented Sep 19, 2018

Uh oh!

Steve Lee (SteveL-MSFT) Sep 24, 2018

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) Sep 25, 2018

Choose a reason for hiding this comment

Uh oh!

Steve Lee (SteveL-MSFT) Sep 24, 2018

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) Sep 25, 2018

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) commented Sep 26, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Add .editorconfig#7357
Travis Plunk (TravisEz13) merged 2 commits into
PowerShell:masterfrom
iSazonov:add-editorconfig

Ilya (iSazonov) commented Jul 25, 2018 •
edited
Loading