Formatter Plugin

A simple formatter plugin for lite and Lite XL.

List of formatter modules

• autoflake python formatter: formatter_autoflake.lua
• black python formatter: formatter_black.lua
• clang-format: formatter_clangformat.lua
• cljfmt: formatter_cljfmt.lua
• cmake-format: formatter_cmakeformat.lua
• csharpier: formatter_csharpier.lua
• crystal: formatter_crystal.lua
• css-beautify: formatter_cssbeautify.lua
• dartformat: formatter_dartformat.lua
• dfmt: formatter_dfmt.lua
• elixir: formatter_elixir.lua
• elm-format: formatter_elmformat.lua
• esformatter: formatter_esformatter.lua
• gdformat: formatter_gdformat.lua
• google-java-format: formatter_googlejavaformat.lua
• goimports: formatter_golang.lua
• html-beautify: formatter_htmlbeautify.lua
• isort python formatter: formatter_isort.lua
• js-beautify: formatter_jsbeautify.lua
• luaformatter: formatter_luaformatter.lua
• ormolu: formatter_ormolu.lua
• perltidy: formatter_perltidy.lua
• prettier: formatter_prettier.lua
• ocp-indent: formatter_ocpindent.lua
• qmlformat: formatter_qml.lua
• rubocop: formatter_rubocop.lua
• ruff: formatter_ruff.lua
• rustfmt: formatter_rustfmt.lua
• shfmt: formatter_shfmt.lua
• vfmt: formatter_vfmt.lua
• sql-formatter: formatter_sqlformatter.lua
• zigfmt: formatter_zigfmt.lua

Installation

1. Copy the formatter.lua file into the lite/lite-xl data/plugins folder

2. To install any specific formatter, copy the corresponding file into the data/plugins folder. List of formatters is at the top of this file.

3. Make sure you have the command that formatter uses installed, or it won't work.

4. Extra configuration: If you want to customize the cli arguments for a specific formatter, you can do this from your init.lua script. Example:

config.jsbeautify_args = {"-r", "-s 4", "-p", "-b end-expand"} -- set jsBeautify arguments to indent with spaces.

Using formatter

The default keymap to format the current doc is alt+shift+f.

The command is formatter:format-doc.

To make Lite XL automatically format the current document on each save, add the following config to USERIDR/init.lua:

config.format_on_save = true

Adding a formatter module

Here is an example of a formatter module:

formatter_jsbeautify.lua

-- mod-version:3 lite-xl 2.1

-- for the JS Beautify fortmatter
local config = require "core.config"
local formatter = require "plugins.formatter"

config.jsbeautify_args = {"-r", "-q", "-s 1", "-t", "-p", "-b end-expand"} -- make sure to keep -r arg if you change this

formatter.add_formatter {
    name = "JS Beautifier",
    file_patterns = {"%.js$"},
    command = "js-beautify $ARGS $FILENAME",
    args = config.jsbeautify_args
}

A few things to keep in mind:

• Add the correct Lite XL version tag at the top
• Keep the arguments inside config.formattername_args
• Set a name
• Add it to the list in README.md and keep it alphabetically sorted

Then make a pull request.