Skip to content
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 for consistent code formatting #3215

Merged
merged 1 commit into from
Jul 2, 2024

Conversation

Matejkob
Copy link
Contributor

@Matejkob Matejkob commented Jun 30, 2024

Xcode 16 added support for the EditorConfig standard1. 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).

Footnotes

  1. Xcode 16 Beta 2 Release Notes–Source Editor New Features

  2. Inspired by: Add an EditorConfig file

  3. Xcode 16 Beta 2 Release Notes–Source Editor Known Issues

Copy link
Member

@stephencelis stephencelis left a comment

Choose a reason for hiding this comment

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

Thanks!

@stephencelis stephencelis merged commit f660a69 into pointfreeco:main Jul 2, 2024
@Matejkob Matejkob deleted the patch-1 branch July 2, 2024 21:17
junbangg pushed a commit to junbangg/swift-composable-architecture that referenced this pull request Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants