Skip to content

Source Code Formatter Plugin


General


The source code formatter plugin integrates various code formatters (aka beautifiers) tools into CodeLite Once integrated, you can format your code using a single key stroke, by default it is set to Ctrl+I

Tool configurations


Each supported tool contains the following properties:

Property name Description
Enabled controls whether the formatter is enabled or not
Inplace edit tells CodeLite whether the formatter outputs the fixed source to stdout, or edit the file directly
Format on save? enable this if you want to format files automatically after saving them
Working directory CodeLite executes the formatter from this directory. Macros are allowed. By default CodeLite uses $(WorkspacePath)
Command the command to execute. Macros are allowed

Integration with remote workspace


Once a remote workspace is loaded (e.g. via Remoty plugin), the plugin replaces the commands defined in the UI with the commands taken from codelite-remote.json configuration file.

Installing tools


Language Tool name Command to install
C/C++ clang-format pacman -Sy mingw-w64-clang-x86_64-clang-tools-extra
JSON jq pacman -Sy mingw-w64-clang-x86_64-jq
Python black pip install black --upgrade
Rust rustfmt pacman -Sy mingw-w64-clang-x86_64-rust
Xml xmllint pacman -Sy mingw-w64-clang-x86_64-libxml2
Yaml yq wget https://github.com/mikefarah/yq/releases/download/v4.28.1/yq_windows_amd64.exe|mv yq_windows_amd64.exe /usr/bin/yq.exe
Language Tool name Command to install
C/C++ clang-format brew install llvm
JSON jq sudo apt-get install jq
Python black pip install black --upgrade
Rust rustfmt curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Xml xmllint sudo apt-get install libxml2-utils
Yaml yq brew install yq
Language Tool name Command to install
C/C++ clang-format brew install llvm
JSON jq brew install jq
Python black pip install black --upgrade
Rust rustfmt curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Xml xmllint Already installed
Yaml yq brew install yq