Add an EditorConfig file #2714
Merged
Add an EditorConfig file #2714
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
|
@swift-ci please test |
mbrandonw
pushed a commit
to pointfreeco/swift-clocks
that referenced
this pull request
Jul 4, 2024
Xcode 16 added support for the [EditorConfig standard](https://editorconfig.org/)[^1]. This allows a project/repo to specify basic formatting rules so the editor can behave correctly.[^2] > [!NOTE] > You may need to quit and relaunch Xcode for it to pick up the `.editorconfig` file after switching to a branch where it's present.[^3] The added `.editorconfig` file contains: ``` # editorconfig.org root = true [*] indent_style = space indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true ``` - `root = true`: Specifies that this is the top-most .editorconfig file. The file search will stop here. - `indent_style = space`: Uses soft tabs (spaces) for indentation instead of hard tabs. - `indent_size = 2`: Sets the indentation to 2 columns. - `trim_trailing_whitespace = true`: Removes any whitespace characters preceding newline characters. - `insert_final_newline = true`: Ensures the file ends with a newline when saving. These settings apply to all files in the project (`[*]`). **This change make much easier the process of switch between projects that use 2-space and 4-space indentation (what is quite common in your community).** [^1]: [Xcode 16 Beta 2 Release Notes–Source Editor New Features](https://arc.net/l/quote/zuzqnfeq) [^2]: Inspired by: [Add an EditorConfig file](swiftlang/swift-syntax#2714) [^3]: [Xcode 16 Beta 2 Release Notes–Source Editor Known Issues](https://arc.net/l/quote/olmnhsqo)
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.
Xcode 16 supports the EditorConfig standard, which allows a project to specify basic formatting rules so the editor can behave correctly. This means no additional configuration is required to get automatic 2-space indentation in Xcode rather than its default 4-space indentation. (You may need to quit and relaunch Xcode for it to pick up the editorconfig file after switching to a branch with it present)
Unfortunately, this does introduce duplication with
.swift-formatbecause both specify the indentation width. (It would be nice if swift-format picked up these settings automatically!)