AlignSettingsSection

Align statements in *** Settings *** section to columns.

Disabling the formatter

AlignSettingsSection is included in the default formatters, but it can be also run separately with:

robocop format --select AlignSettingsSection

You can also disable it:

robocop format --configure AlignSettingsSection.enabled=False

BeforeAfter

*** Settings ***
Library      SeleniumLibrary
Library   Mylibrary.py
Variables  variables.py
Test Timeout  1 min
  # this should be left aligned

*** Settings ***
Library         SeleniumLibrary
Library         Mylibrary.py
Variables       variables.py
Test Timeout    1 min
# this should be left aligned

Align up to columns

You can configure how many columns should be aligned to the longest token in the given column. The remaining columns will use fixed length separator length --space-count. By default, only the first two columns are aligned.

Example of how the AlignSettingsSection formatter behaves with the default configuration and multiple columns:

BeforeAfter

*** Settings ***
Library    CustomLibrary   WITH NAME  name
Library    ArgsedLibrary   ${1}  ${2}  ${3}

Documentation     Example using the space separated format.
...  and this documentation is multiline
...  where this line should go I wonder?

*** Settings ***
Library             CustomLibrary    WITH NAME    name
Library             ArgsedLibrary    ${1}    ${2}    ${3}

Documentation       Example using the space separated format.
...                 and this documentation is multiline
...                 where this line should go I wonder?

You can configure it to align three columns:

cli toml

robocop format -c AlignSettingsSection.up_to_column=3

[tool.robocop.format]
configure = [
    "AlignSettingsSection.up_to_column=3"
]

will result in:

BeforeAfter

*** Settings ***
Library    CustomLibrary   WITH NAME  name
Library    ArgsedLibrary   ${1}  ${2}  ${3}

Documentation     Example using the space separated format.
...  and this documentation is multiline
...  where this line should go I wonder?

*** Settings ***
Library             CustomLibrary    WITH NAME    name
Library             ArgsedLibrary    ${1}         ${2}     ${3}

Documentation       Example using the space separated format.
...                 and this documentation is multiline
...                 where this line should go I wonder?

To align all columns set up_to_column to 0.

Extra indent for keyword arguments

Arguments in multi-line settings are indented by additional argument_indent (default 4) spaces. You can configure the indent or disable it by setting argument_indent to 0.

argument_indent=4 (default)argument_indent=2argument_indent=0

*** Settings ***
Suite Setup         Start Session
...                     host=${IPADDRESS}
...                     user=${USERNAME}
...                     password=${PASSWORD}
Suite Teardown      Close Session

*** Settings ***
Suite Setup         Start Session
...                   host=${IPADDRESS}
...                   user=${USERNAME}
...                   password=${PASSWORD}
Suite Teardown      Close Session

*** Settings ***
Suite Setup         Start Session
...                 host=${IPADDRESS}
...                 user=${USERNAME}
...                 password=${PASSWORD}
Suite Teardown      Close Session

WITH NAME arguments are not indented:

BeforeAfter

*** Settings ***
Library             SeleniumLibrary
...                 timeout=${TIMEOUT}
...                 implicit_wait=${TIMEOUT}
...                 run_on_failure=Capture Page Screenshot
...                 WITH NAME    Selenium

*** Settings ***
Library             SeleniumLibrary
...                     timeout=${TIMEOUT}
...                     implicit_wait=${TIMEOUT}
...                     run_on_failure=Capture Page Screenshot
...                 WITH NAME    Selenium

Fixed the width of the column

It's possible to set the fixed width of the column. To configure it use fixed_width parameter:

cli toml

robocop format -c AlignSettingsSection.fixed_width=30

[tool.robocop.format]
configure = [
    "AlignSettingsSection.fixed_width=30"
]

This configuration respects up_to_column parameter but ignores argument_indent.

BeforeAfter

*** Settings ***
Library    CustomLibrary   WITH NAME  name
Library    ArgsedLibrary   ${1}  ${2}  ${3}

Documentation     Example using the space separated format.
...  and this documentation is multiline
...  where this line should go I wonder?

*** Settings ***
Library                      CustomLibrary   WITH NAME  name
Library                      ArgsedLibrary   ${1}  ${2}  ${3}

Documentation                Example using the space separated format.
...                          and this documentation is multiline
...                          where this line should go I wonder?

Minimal width of the column

It's possible to set the minimal width of the column. To configure it use min_width parameter:

cli toml

robocop format -c AlignSettingsSection.min_width=20

[tool.robocop.format]
configure = [
    "AlignSettingsSection.min_width=20"
]

This configuration respects up_to_column parameter.

BeforeAfter

*** Settings ***
Library    CustomLibrary   WITH NAME  name
Library    ArgsedLibrary   ${1}  ${2}  ${3}

Documentation     Example using the space separated format.
...  and this documentation is multiline
...  where this line should go I wonder?

*** Settings ***
Library             CustomLibrary   WITH NAME  name
Library             ArgsedLibrary   ${1}  ${2}  ${3}

Documentation       Example using the space separated format.
...                 and this documentation is multiline
...                 where this line should go I wonder?

Select lines to format

AlignSettingsSection does also support global formatting params --start-line and --end-line:

cli toml

robocop format --start-line 2 --end-line 3 --configure AlignSettingsSection.up_to_column=3

[tool.robocop.format]
start-line = 2
end-line = 3
configure = [
    "AlignSettingsSection.up_to_column=3"
]

will result in:

BeforeAfter

*** Settings ***
Metadata  Version  2.0  # this should be not aligned
Metadata      More Info  For more information about *Robot Framework* see http://robotframework.org
Metadata     Executed At  {HOST}

*** Settings ***
Metadata  Version  2.0  # this should be not aligned
Metadata    More Info       For more information about *Robot Framework* see http://robotframework.org
Metadata    Executed At     {HOST}

Skip formatting

It is possible to use the following arguments to skip formatting of the code:

• skip option (--skip documentation)

It is highly recommended to use one of the skip options if you wish to use the alignment, but you have part of the code that looks better with manual alignment. It is also possible to use disablers but skip option makes it easier to skip all instances of the given type of code.