Skip to main content

leading_newlines_in_multiline_strings

Learn about the leading_newlines_in_multiline_strings linter rule.

Stable
Fix available

Start multiline strings with a newline.

Details

#

Multiline strings are easier to read when they start with a newline (a newline starting a multiline string is ignored).

BAD:

dart
var s1 = '''{  "a": 1,  "b": 2 }'''; 

GOOD:

dart
var s1 = ''' {  "a": 1,  "b": 2 }''';  var s2 = '''This one-liner multiline string is ok. It usually allows to escape both ' and " in the string.'''; 

Enable

#

To enable the leading_newlines_in_multiline_strings rule, add leading_newlines_in_multiline_strings under linter > rules in your analysis_options.yaml file:

analysis_options.yaml
yaml
linter:  rules:  - leading_newlines_in_multiline_strings 

If you're instead using the YAML map syntax to configure linter rules, add leading_newlines_in_multiline_strings: true under linter > rules:

analysis_options.yaml
yaml
linter:  rules:  leading_newlines_in_multiline_strings: true