Rule to indent multiline strings

[hartbit]

It would be nice to have a rule to indent multiline strings from:

let sql = """
SELECT *
FROM authors
WHERE authors.name LIKE '%David%'
"""

into

let sql = """
    SELECT *
    FROM authors
    WHERE authors.name LIKE '%David%'
    """

It seems to be the style most often used in the community too.

[nicklockwood]

@hartbit sorry for not responding earlier. Seems like a reasonable feature - would you be interested in creating a PR?

[hartbit]

I have very little left for Open Source contributions :-( I'll have a look but I can't promise anything.

[neilt]

Also note that indentation inside the multiline string should be preserved.

For example:

let sql = """
    SELECT *
    FROM  authors,
          books
    WHERE authors.name LIKE '%David%'
         AND pubdate < $1
    """

[nicklockwood]

@neilt yes, that logic is already in place.

The SwiftFormat tokenizer actually bakes the relative indent into the string tokens themselves, so as long as the string lines are all given the same indent, the relative indent will be correctly preserved.

[facumenzella]

Hello there 👋
I was wondering how did you think about this rule? I've managed to write something for multilineStringAssignmets like the examples above, but I have some doubts about it:

1. Do you think something like indentMultilineStringAssignments makes sense as a separate rule?

2. Where should the .startOfScope(""") be? This should probably be another rule, right?

+++ let sql = """
--- let sql = 
---    """
    SELECT *
    FROM  authors,
          books
    WHERE authors.name LIKE '%David%'
         AND pubdate < $1
    """

[nicklockwood]

@facumenzella my understanding of the feature request was that it should convert:

let sql = """
SELECT *
FROM  authors,
      books
WHERE authors.name LIKE '%David%'
     AND pubdate < $1
"""

to:

let sql = """
    SELECT *
    FROM  authors,
          books
    WHERE authors.name LIKE '%David%'
         AND pubdate < $1
    """

Which I think should not be a new rule, but a configuration option like --indentstrings true that is applied by the existing indent rule.

Unwrapping the """ onto previous line seems like a different requirement.

[nicklockwood]

@hartbit implemented in 0.49.0