Add support for Robot Framework files with robotidy

CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog].
 
+## Unreleased
+
+### Formatters
+* [`robotidy`](https://robotidy.readthedocs.io) for Robot Framework files.
+
 ## 4.0 (released 2023-11-23)
 ### Breaking changes
 * The order of entries in `apheleia-mode-alist` is no longer as

apheleia-formatters.el

@@ -136,6 +136,9 @@
         "--parser=yaml"
         (apheleia-formatters-js-indent "--use-tabs" "--tab-width")))
     (purs-tidy . ("apheleia-npx" "purs-tidy" "format"))
+    (robotidy . ("robotidy" "--no-color" inplace
+                 (apheleia-formatters-indent nil "--indent")
+                 (apheleia-formatters-fill-column "--line-length")))
     (rubocop . ("rubocop" "--stdin" filepath "--auto-correct"
                 "--stderr" "--format" "quiet" "--fail-level" "fatal"))
     (ruby-standard . ("standardrb" "--stdin" filepath "--fix" "--stderr"
@@ -306,6 +309,7 @@ rather than using this system."
     (purescript-mode . purs-tidy)
     (python-mode . black)
     (python-ts-mode . black)
+    (robot-mode . robotidy)
     (ruby-mode . prettier-ruby)
     (ruby-ts-mode . prettier-ruby)
     (rustic-mode . rustfmt)

apheleia-utils.el

@@ -46,6 +46,7 @@ always returns nil to defer to the formatter."
               (json-mode 'js-indent-level)
               (json-ts-mode 'json-ts-mode-indent-offset)
               (nxml-mode 'nxml-child-indent)
+              (robot-mode 'robot-mode-basic-offset)
               (scss-mode 'css-indent-offset)
               (web-mode 'web-mode-indent-style)
               (tsx-ts-mode 'typescript-ts-mode-indent-offset)

test/formatters/installers/robotidy.bash

@@ -0,0 +1,2 @@
+apt-get install -y python3-pip
+python3 -m pip install robotframework-tidy

test/formatters/samplecode/robotidy/in.robot

@@ -0,0 +1,22 @@
+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 ***

test/formatters/samplecode/robotidy/out.robot

@@ -0,0 +1,23 @@
+*** Comments ***
+Force Tags    tags    tag2
+Library    Collections
+Resource    important.robot
+Library    MyCustomLibrary.py
+
+Test Setup    Setup Keyword
+
+
+*** Variables ***
+${var}=             2
+${bit_longer}       10
+${var2}             a
+...                 b
+
+
+*** Test Cases ***
+Test1
+    Keyword
+    FOR    ${var}    IN RANGE    10
+        IF    ${var}>5    Other Keyword
+    END
+    [Teardown]    Teardown Keyword