Skip to content

Add editorconfig for a degree of IDE formatting consistency #588

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.

Sign up for GitHub

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

Merged
rnorth merged 2 commits into from
Feb 25, 2018
Merged

Add editorconfig for a degree of IDE formatting consistency #588

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1dd0f50
Add editorconfig for a degree of IDE formatting consistency
rnorth Feb 24, 2018
f439846
Add md rule
rnorth Feb 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# EditorConfig is awesome: http://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
Copy link
Member Author

@rnorth rnorth Feb 24, 2018

Choose a reason for hiding this comment

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

Tempted to leave this as just *.java - thoughts?

Copy link
Member

@bsideup bsideup Feb 24, 2018

Choose a reason for hiding this comment

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

I checked a few other projects, they seem to use [*]

Also, I recommend adding:

[*.md]
trim_trailing_whitespace = false

Because in Markdown there is (two trailing spaces) to break the line

Copy link
Member

@bsideup bsideup Feb 24, 2018

Choose a reason for hiding this comment

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

Plus trim_trailing_whitespace = true to [*]

Copy link
Member Author

@rnorth rnorth Feb 24, 2018

Choose a reason for hiding this comment

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

Good idea, will do. Thanks!

Copy link
Member Author

@rnorth rnorth Feb 24, 2018

Choose a reason for hiding this comment

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

Done

Copy link
Member

@kiview kiview Feb 25, 2018

Choose a reason for hiding this comment

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

I think it's good to have lf for all files, especially bash files, to make life easier for Windows development (currently we've solved this with the .gitattributes). And this might also help us in achieving remote caching for Windows builds for local development (not for CI though?).

Copy link
Member

@kiview kiview Feb 25, 2018

Choose a reason for hiding this comment

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

Hm no, it doesn't help with Windows cache, since it's only applied for edited files? But it's fine, we can solve it another way some day ;)

end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 4
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false