app ucf

A universal code formatter

5 releases

0.1.4 Feb 5, 2023
0.1.3 Jan 28, 2023
0.1.2 Jan 28, 2023
0.1.1 Jan 23, 2023
0.1.0 Jan 22, 2023

#169 in Development tools

28 downloads per month

MIT license

159 lines

Universal Code Formatter

Latest Version

A code formatter that formats any code.


With cargo

cargo install ucf


ucf <file_name>

Caution: ucf modifies the file in place and there is no option to output to stdout at the moment.

ucf --help

prints help.

Inner working

ucf is a simple program. It determines the file extension and calls a predetermined code formatter on the file as listed in the table below with necessary arguments to modify the file in place. The formatter called should be present in the system's PATH.

Currently used formatters

Formatter called File Extension
black .py
clang-format .c, .cpp, .cc, .cs, .cxx, .cp, .cs, .h, .hpp, .hxx .java, .json, .m (objective c, not matlab)
cmake-format .cmake
gofmt .go
ocamlformat .ocaml
prettier .css, .gfm, .graphql, .gql, .html, .js, .jsx, .less, .md, .mdx, .prettierrc, .sass, .scss, .svelte, .ts, .vue, .yaml
rustfmt .rs
shfmt .sh, .ebuild
stylua .lua
stylish-haskell .hs
taplo .toml
xmllint .xml
zig fmt .zig

Editor Integration

vim / neovim

After saving the file, run ucf on the file as a shell command.

:!ucf %

This can be automated in many ways, eg. To bind <F5> to save and format the file, add the following line in init.lua,

vim.keymap.set('n', '<F5>', ':w | :!ucf % <CR><CR>', {noremap=true, silent=true})

Config file

To ignore certain file extensions, add the extensions without the dot in the ignored_extensions array in $XDG_CONFIG_HOME/ucf/config.toml file. ucf formats code overriding the config file if a custom formatter is given.

Read more here


All patches are welcome. Fork the repo, make your changes and submit a pull request.


~48K SLoC