Robotidy is a tool for autoformatting Robot Framework code.
It is spiritual descendant of Robot Framework's internal robot.tidy package.
Full documentation available here. ๐
Python 3.7+ ๐ and Robot Framework 4.0.0+ ๐ค.
You can install Robotidy simply by running:
pip install -U robotframework-tidy
Call robotidy with path(s) to file/directory with robot files:
robotidy tests
robotidy test.robot
robotidy tests/resources test.robot
All command line options can be displayed in help message by executing:
robotidy --help
See documentation for information how to configure robotidy.
Ugly code before transforming with robotidy:
*** Settings ***
Force Tags tags tag2
Library Collections
Resource important.robot
Library MyCustomLibrary.py
Test Setup Setup Keyword
*** test case*
Test1
[ teardown] Teardown Keyword
Keyword
FOR ${var} IN RANGE 10
Run Keyword If ${var}>5 Other Keyword
END
*** Variables ***
${var}= 2
${bit_longer} 10
${var2} a
... b
*** Keywords ***
A lot prettier code after:
*** Settings ***
Library Collections
Library MyCustomLibrary.py
Resource important.robot
Test Setup Setup Keyword
Force Tags tags tag2
*** Variables ***
${var} 2
${bit_longer} 10
${var2} a
... b
*** Test Cases ***
Test1
Keyword
FOR ${var} IN RANGE 10
IF ${var}>5
Other Keyword
END
END
[Teardown] Teardown Keyword