-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Add .editorconfig #7357
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
Add .editorconfig #7357
Conversation
.editorconfig
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't in our style: https://github.com/PowerShell/PowerShell/blob/master/docs/dev-process/coding-guidelines.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please clarify? We have in the guideline:
Use _camelCase to name internal and private fields and use readonly where possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
|
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. |
|
@SteveL-MSFT Could you please share plans about fixing style issues? |
|
@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. |
|
@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
bda45b9 to
54c0de2
Compare
|
Rebased to update CIs. |
.editorconfig
Outdated
| # (Please don't specify an indent_size here; that has too many unintended consequences.) | ||
|
|
||
| # Code files | ||
| [*.{cs,csx,vb,vbx}] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't have any vb code, but we do have cpp.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed.
.editorconfig
Outdated
| charset = utf-8 | ||
|
|
||
| # Xml project files | ||
| [*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what about ps1xml files? Should we remove extensions we don't use in this repo?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added resx,ps1xml. Removed unused.
|
@TravisEz13 Can we merge? Or we should address
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
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
.h,.cpp,.cs,.ps1and.psm1files have the correct copyright headerWIP:to the beginning of the title and remove the prefix when the PR is ready.[feature]if the change is significant or affects feature tests