Skip to content

Code Style

Jump to bottom
Austin Condiff edited this page Apr 27, 2023 · 17 revisions

Code Style

Every programmer has their own preference on what coding style to use. But when working in a team it is important we have a consistent style throughout our codebase.

See the SwiftLint section to see how we test the coding style in our project.

Swift

CodeEdit is entirely written using Swift. We decided to choose SwiftUI for most parts of the app where it makes sense. Though some parts require the implementation of AppKit code due to mostly customizability and performance reasons.

We currently are targeting macOS 13 since it enables us to use ExtensionKit and many crucial new SwiftUI libraries. But we don't see this as a problem since once we reach the final release stage macOS 13 will most likely be standard. Further, most developers tend to keep their machines on the latest firmware version anyways - if not even firmware in beta stage.

Basics

We use the standard code style used in the Swift Language Guide. If you're not familiar please have a read!

Spaces/Tabs

In CodeEdit we decided to use Spaces instead of Tabs. A \t will be translated into 4 spaces. This is setup in our projects settings and must not be changed.

var vs. let

We encourage you to use let foo = ... over var foo = ... wherever possible.

This is to make clear to others whether a value will change or not.

guard over if

Use guard over if when the execution should stop when the criteria are not met:

/* Don't use this */
if fruits.isEmpty {
    // do stuff here
} else {
    return
}

/* Use this instead */
guard fruits.isEmpty else { return }
// do stuff here

Don't force-unwrap

Force-unwrapping Optional values is never a good practice since the app will crash when it fails.

Instead of unwrapping let foo: FooType? don't use foo! to unwrap. Use this instead:

if let foo = foo {
    /// use safely unwrapped foo here
}

In case of optional chaining you can easily use this: foo?.someFunctionCall().

Implicit return and get

When possible don't use explicit return statements when they are not required.

/* Don't use this */
var someProperty: String {
    get {
        return "Hello, World!"
    }
}

/* Use this instead */
var someProperty: String {
    "Hello, World!"
}

Access Control

Functions and properties in a class or struct should be considered private unless they need to be either internal or public.

When an entity (Which can be a property, struct, class or func) should be internal, do not explicitly mark it, in Swift every entity is implicitly internal.

/* Don't use this */
internal struct Hello {}

/* Use this instead */
struct Hello {}

When working on the CodeEdit main codebase, do not mark any entity as public. CodeEdit should not and cannot be used as library.

In a struct create a designated init and set the private properties there.

Parameter Alignment

When breaking up your parameters of functions/methods or type initializers into multiple lines we recommend to also put the first parameter on a new line as well. This enhances readability and structure. This also applies to multiline array initializations.

/* Don't use this */
func aVeryLongFunctionName(_ with: String, 
                           multiple: Int, 
                           parameters: [String]) -> Bool {
    // function body
}

/* Use this instead */
func aVeryLongFunctionName(
    _ with: String, 
    multiple: Int, 
    parameters: [String]
) -> Bool {
    // function body
}

Naming Conventions

Naming your properties and functions/methods appropriately is very important so people understand what they are doing.

Instead of var n: Int = 4 use var number: Int = 4.

Attributes

Place attributes above the entity on which you apply it. Not in front of it.

/* Don't use this */
@State var number: Int = 4

/* Use this instead */
@State
var number: Int = 4

Function Headers

Reduce redundancy in function headers whenever possible.

/* Don't use this */
func addNumber(number: Int, toNumber: Int) {}

/* Use this instead */
func addNumber(_ num1: Int, to num2: Int) {}

Documentation

Before submitting a pull request, make sure your code is well documented.

  • Add comments to larger blocks of code describing what the steps do.
  • Add Swift documentation to all public struct, class, enum, var/let and func declarations.

To add documentation blocks ⌘ + click on the name of the desired type and select Add Documentation.

Remove Comments and print

In your final code there should not be any commented code or print() statements. Please remove them.

Same goes for // swiftlint:disable comments.

External Dependencies

We only use a handful of external libraries. Don't add external dependencies without prior discussion in issues or on Discord.

This is because we want to keep our dependencies as slim as possible. In certain cases it might make sense to use an external library though.

Keep in mind that most of UI related extensions or convenience methods can easily be implemented in a internal module/package.

View Models

When having more than a couple of state changing variables (@State) in a SwiftUI view, create a specific ViewModel for that view which will handle all the logic (MVVM).

It is always good practice to keep logic and UI separated.

Properties can then be marked as @Published and be observed via the ViewModels instance in the view.

Function Body Length

Don't go wild and put a ton of logic in a single function. Break it up into smaller sections where it makes sense.

This is especially important in SwiftUI views. Create subviews instead!

By breaking up the code into smaller chunks it is much easier to understand the overall structure and flow.

SwiftLint

To enforce our style we settled on, we use a tool called SwiftLint. It gets executed at build time and injects error messages right into Xcode.

Installation

All you have to do is installing it using Homebrew:

brew install swiftlint

Update

Make sure you have a recent release of SwiftLint installed. To update simply run:

brew update && brew upgrade swiftlint

Configuration

We basically use the standard configuration with a handful of changes. Our current configuration looks like this:

disabled_rules:
  - todo
  - trailing_comma
  - nesting

type_name:
  excluded:
    - ID

identifier_name:
  excluded:
    - id
    - vc

opt_in_rules:
  - empty_count
  - contains_over_first_not_nil

custom_rules:
  spaces_over_tabs:
    included: ".*\\.swift"
    name: "Spaces over Tabs"
    regex: "\t"
    message: "Prefer spaces for indents over tabs. See Xcode setting: 'Text Editing' -> 'Indentation'"
    severity: warning

Note that we're using --strict mode both locally in the project as well as in our CI environment which runs our tests on submission of pull requests.

Recommendation

We recommend to change the following setting in Xcode:

  • Preferences > Text Editing > Editing and enable:
    • Automatically trim trailing whitespace
      • Including whitespace-only lines
Clone this wiki locally