Add editorconfig file for setting coding style #770
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
poll-busily
changed the title
poll-busily
force-pushed
the
editorconfig
branch
from
e55889a
to
0e0a680
Compare
|
I like this to be added. |
poll-busily
changed the title
Editorconfig is a standard, supported by many popular editing tools, that helps set required editor settings automatically to support the project's coding style. It's not a linter / auto-formatter, it just sets a few basic options. Supported editors will pick up these settings specifically for the cloudlog source directory, not interfering with project or user settings in other locations. This config specifies UTF-8 encoding and LF line-endings for all project files, tabbed indentation for source and data files and finally final newlines and whitespace trimming just for source files. These are based on what I saw in https://github.com/magicbug/Cloudlog/wiki/Development-Notes and from the dominant formatting options in the existing source files. All open to changes, of course. If an editor is set up to perform reformatting of code automatically (e.g. on save or on paste) then these rules will influence that behaviour, but they will not cause an editor to reformat existing code on their own.
poll-busily
force-pushed
the
editorconfig
branch
from
0e0a680
to
32fa20a
Compare
|
Got a few thumbs up on this so far. What are your thoughts, @magicbug? Is it okay to go in? |
|
I would like this as well. |
|
I'm OK for it to go in, sorry for the delay, been rough few weeks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While cleaning up my last PR I realised that I had to set some editor style settings. In previous projects I've used an editorconfig file to automate this.
Editorconfig is a standard that helps set editor settings automatically to support the project's coding style. It's not related to linting or auto-formatting directly, focusing instead on setting the style for newly-written or modified code.
Supported editors will pick up and apply these settings for the Cloudlog source directory, not interfering with other project folders or user settings in other locations.
This config specifies UTF-8 encoding and LF line-endings for all project files, tabbed indentation for source and data files and, finally, trailing newlines and whitespace trimming just for source files. These rules are based on what I saw in https://github.com/magicbug/Cloudlog/wiki/Development-Notes and from the dominant formatting options in the existing source files. All open to changes, of course, which is why this is a draft PR.
If an editor is set up to perform reformatting of code automatically (e.g. on save or on paste) then these rules will influence that behaviour, but applying them won't cause an editor to reformat existing code en-masse.