Missing new keyword 'setup' setting in OrderSettings transformer

[gohierf]

Since RF 7.0, keywords now accept a setup argument.

This is not yet supported by robotidy OrderSettings transformer and result in the following error:

Error: OrderSettings: Invalid 'keyword_before' parameter value: 'arguments,documentation,tags,timeout,setup'. Custom order should be provided in comma separated list with valid setting names: arguments,documentation,return,tags,teardown,timeout

Side note, regarding documentation

While we are on the subject of OrderSettings transformers, I found that the documentation is lacking the following:

• the first before/after example only shows "keyword" reordering. It would be nice to add a "testcase" to it for completeness.
• the second before/after example could also show both "testcase" and "keyword", to highlight that default keyword_before and keyword_after were not modified when configuring test_before and test_after. Although this can be deduced by reading the current documentation carefully, adding it in the example might help to find this out.
• finally, it is not quite clear that it is possible to configure keyword_before, keyword_after, test_before, and test_after, in separate CLI/toml configuration calls. It was not obvious to me.

Another side note, regarding robotcode

My need to put the arguments setting first originated from a current limitation in robotcode. Maybe you have some information to share on the topic?

[bhirsz]

1) Thanks for pointing it out, it will be fixed

2) And thanks for all notes for documentation - it's really helpfull as the tool is only as good as its documentation, with missing bits it would be not used :)

3) Looking into it, I believe the timeout default order should be moved. Ideally after arguments since it can have variables from arguments (which btw may not be supported by robotidy/robocop variable rules/transformers)

[bhirsz]

Style guide already propose (based on User Guide) a bit better order:

https://docs.robotframework.org/docs/style_guide#settings

I've also checked - [Tags] and [Documentation] can't use values from arguments, only from global variables. [Timeout], [Setup] and [Teardown] can use [Arguments]. Hence proposed order will work best.

Test code I used for debugging:

*** Variables ***
${global}    global

*** Test Cases ***
Test
    Dynamic Tag    smoke    1

Test 2
    Dynamic Tag    regression    2

*** Keywords ***
Dynamic Tag
    [Arguments]    ${arg}   ${arg2}
    [Documentation]    Doc with ${arg} and ${global}
    [Tags]    my-${arg}
    [Timeout]    ${arg2} min
    Log    ${arg}