RenameKeywords

Enforce keyword naming. Title Case is applied to keyword name and underscores are replaced by spaces. It has only basic support for keywords with embedded variables - use it on your own risk.

Enabling the transformer

RenameKeywords is not included in default transformers, that’s why you need to call it with --transform explicitly:

robotidy --transform RenameKeywords src

Or configure enabled parameter:

robotidy --configure RenameKeywords:enabled=True

You can keep underscores if you set remove_underscores to False:

robotidy --transform RenameKeywords -c RenameKeywords:remove_underscores=False .

Keyword case

By default each word in keyword case is capitalized. It can be configured using keyword_case parameter:

Before

*** Keywords ***
keyword name
    Log    ${GLOBAL}
    perform Action

keyword_case = capitalize_words (default)

*** Keywords ***
Keyword Name
    Log    ${GLOBAL}
    Perform Action

keyword_case = capitalize_first

*** Keywords ***
Keyword name
    Log    ${GLOBAL}
    Perform Action

keyword_case = ignore

*** Keywords ***
keyword name
    Log    ${GLOBAL}
    perform Action

Library name

By default library name in keyword name is ignored. Anything before the last dot in the name is considered as a library name. Use ignore_library = True parameter to control if the library name part (Library.Keyword) of keyword call should be renamed.

Before

*** Keywords ***
Keyword
    library_name.keyword

ignore_library = True

*** Keywords ***
Keyword
    library_name.Keyword

ignore_library = False

*** Keywords ***
Keyword
    Library Name.Keyword

Replace pattern

It is also possible to configure replace_pattern parameter to find and replace regex pattern. Use replace_to to set replacement value. This configuration (underscores are used instead of spaces):

robotidy --transform RenameKeywords -c RenameKeywords:replace_pattern=(?i)^rename\s?me$:replace_to=New_Shining_Name .

replaces all occurrences of name Rename Me` (case insensitive thanks to (?i) flag) to New Shining Name:

Before

*** Keywords ***
rename Me
   Keyword Call

After

*** Keywords ***
New Shining Name
    Keyword Call

This feature makes this transformer convenient tool for renaming your keywords across Robot Framework project.