Configuration.md

swift-format Configuration

swift-format allows users to configure a subset of its behavior, both when used as a command line tool or as an API.

Command Line Configuration

A swift-format configuration file is a JSON file with the following top-level keys and values:

• version (number): The version of the configuration file. For now, this should always be 1.

• lineLength (number): The maximum allowed length of a line, in characters.

• indentation (object): The kind and amount of whitespace that should be added when indenting one level. The object value of this property should have exactly one of the following properties:

  • spaces (number): One level of indentation is the given number of spaces.
  • tabs (number): One level of indentation is the given number of tabs.

• tabWidth (number): The number of spaces that should be considered equivalent to one tab character. This is used during line length calculations when tabs are used for indentation.

• maximumBlankLines (number): The maximum number of consecutive blank lines that are allowed to be present in a source file. Any number larger than this will be collapsed down to the maximum.

• respectsExistingLineBreaks (boolean): Indicates whether or not existing line breaks in the source code should be honored (if they are valid according to the style guidelines being enforced). If this settings is false, then the formatter will be more "opinionated" by only inserting line breaks where absolutely necessary and removing any others, effectively canonicalizing the output.

• lineBreakBeforeControlFlowKeywords (boolean): Determines the line-breaking behavior for control flow keywords that follow a closing brace, like else and catch. If true, a line break will be added before the keyword, forcing it onto its own line. If false (the default), the keyword will be placed after the closing brace (separated by a space).

• lineBreakBeforeEachArgument (boolean): Determines the line-breaking behavior for generic arguments and function arguments when a declaration is wrapped onto multiple lines. If true, a line break will be added before each argument, forcing the entire argument list to be laid out vertically. If false (the default), arguments will be laid out horizontally first, with line breaks only being fired when the line length would be exceeded.

• lineBreakBeforeEachGenericRequirement (boolean): Determines the line-breaking behavior for generic requirements when the requirements list is wrapped onto multiple lines. If true, a line break will be added before each requirement, forcing the entire requirements list to be laid out vertically. If false (the default), requirements will be laid out horizontally first, with line breaks only being fired when the line length would be exceeded.

• prioritizeKeepingFunctionOutputTogether (boolean): Determines if function-like declaration outputs should be prioritized to be together with the function signature right (closing) parenthesis. If false (the default), function output (i.e. throws, return type) is not prioritized to be together with the signature's right parenthesis, and when the line length would be exceeded, a line break will be fired after the function signature first, indenting the declaration output one additional level. If true, A line break will be fired further up in the function's declaration (e.g. generic parameters, parameters) before breaking on the function's output.

• indentConditionalCompilationBlocks (boolean): Determines if conditional compilation blocks are indented. If this setting is false the body of #if, #elseif, and #else is not indented. Defaults to true.

• lineBreakAroundMultilineExpressionChainComponents (boolean): Determines whether line breaks should be forced before and after multiline components of dot-chained expressions, such as function calls and subscripts chained together through member access (i.e. "." expressions). When any component is multiline and this option is true, a line break is forced before the "." of the component and after the component's closing delimiter (i.e. right paren, right bracket, right brace, etc.).

• spacesAroundRangeFormationOperators (boolean): Determines whether whitespace should be forced before and after the range formation operators ... and ..<.

• multiElementCollectionTrailingCommas (boolean): Determines whether multi-element collection literals should have trailing commas. Defaults to true.

TODO: Add support for enabling/disabling specific syntax transformations in the pipeline.

Example

An example .swift-format configuration file is shown below.

{
    "version": 1,
    "lineLength": 100,
    "indentation": {
        "spaces": 2
    },
    "maximumBlankLines": 1,
    "respectsExistingLineBreaks": true,
    "lineBreakBeforeControlFlowKeywords": true,
    "lineBreakBeforeEachArgument": true
}

Linter and Formatter Rules Configuration

In the rules block of .swift-format, you can specify which rules to apply when linting and formatting your project. Read the rules documentation to see the list of all supported linter and formatter rules, and their overview.

You can also run this command to see the list of rules in the default swift-format configuration:

$ swift-format dump-configuration

API Configuration

The SwiftConfiguration module contains a Configuration type that is equivalent to the JSON structure described above. (In fact, Configuration conforms to Codable and is how the JSON form is read from and written to disk.)

The SwiftFormatter and SwiftLinter APIs in the SwiftFormat module take a mandatory Configuration argument that specifies how the formatter should behave when acting upon source code or syntax trees.

The default initializer for Configuration creates a value equivalent to the default configuration that would be printed by invoking swift-format dump-configuration. API users can also provide their own configuration by modifying this value or loading it from another source using Swift's Codable APIs.