Add rule for proper indentation with preconfigured number of spaces

[Johennes]

It would be great to check for a consistent indentation using e.g. 2 or 4 space for each level of nesting. Here are some violating examples:

class Foo {
let bar: String
}

class Foo {
    func bar() {
      return "foo"
    }
}

In addition, it'll also be nice to check for a consistent indentation of multi-line array/dictionary or string constructs. Violating examples:

let a = ["foo",
"foo",
"foo"]

let a = "foo"
+ "bar"
+ "foobar"

[ecnepsnai]

Any update on this @jpsim ? Would really value this rule.

[jpsim]

It's up for grabs, no one has started work on this as far as I know.

[arsonik]

+1

[qasim]

Working on this over at master...qasim:qasim/add-indentation. ☺️

[rudolf-adamkovic]

@qasim Any updates on this one?

[ldiqual]

@Johennes @salutis @ecnepsnai I've created a PR addressing the first part of this issue. Please feel free to 👍 if you'd like to express interest! #873

[fredpi]

The new indentation_width opt-in rule is now available (see #2765), so maybe we can close this issue? Or should we wait until there's also a more advanced / flexible indentation rule?

[jpsim]

Let's close this. Anyone should feel empowered to file new, more specific issues about further enhancements. Thanks @fredpi!

[keith]

FYI it looks like this rule is incompatible with this style:

        XCTAssertEqual(foo,
                       "blah")

which we use when the first line would overflow our column length limit

[fredpi]

@keith That's by design, as the rule suggests the following style in case of overflow:

XCTAssertEqual(
   foo,
   "blah"
)

[jpsim]

It' be awesome to add a configuration option to support the first style too.

[ptrkstr]

@fredpi @jpsim was support added for the first style?
It'd be useful for instances like:

[textField,
 callButton].forEach(addSubview)

[fredpi]

@patrickBDev Unfortunately, that's not yet available and currently, I don't have the time to implement it 🙁 Feel free though to open a new issue specifically explaining the desired changes!

[hisavali]

In my swiftlint.yml

there is entry

opt_in_rules:
  - indentation_width

When I run 👇 on terminal,

> echo "foo(top: "top", 
bottom: ."bottom", title: "hello world")" | swiftlint lint --no-cache --use-stdin --enable-all-rules

swiftlint prints violation warning:

<nopath>:2:1: warning: Indentation Width Violation: Code should be indented using one tab or 4 spaces. (indentation_width)
Done linting! Found 1 violation, 0 serious in 1 file.

However, when I run swift autocorrect, correction is not made.
Has anyone noticed something similar?

[fredpi]

@hisavali This is expected behavior, as autocorrection is not yet available for the indentation_width rule. Feel free to open a dedicated issue to track progress on such a feature.