Skip to content
Auto-format source code in many languages with one command
Emacs Lisp
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore Add .gitignore Mar 24, 2018
LICENSE Clarify license Mar 30, 2019
README.md Support Dockerfile formatting using dockfmt Oct 27, 2019
format-all.el Support Dockerfile formatting using dockfmt Oct 27, 2019

README.md

format-all for Emacs

What does it do

Lets you auto-format source code in many languages using the same command for all languages, instead of learning a different Emacs package and formatting command for each language.

Just do M-x format-all-buffer and it will try its best to do the right thing. To auto-format code on save, use the minor mode format-all-mode. Please see the documentation for that function for instructions.

Supported languages

How to install

From MELPA

You will need to install external programs to do the formatting. If format-all-buffer can't find the right program, it will try to tell you how to install it.

If you have installed a formatter but Emacs cannot find it, Emacs may be using a PATH different from your shell. The path searched by Emacs is in the exec-path variable. You can easily make it match your shell's PATH using the exec-path-from-shell package from MELPA.

How to customize

There are currently no customize variables, since it's not clear what approach should be taken. Please see GitHub issues for discussion.

Many of the external formatters support configuration files in the source code directory to control their formatting. Please see the documentation for each formatter.

How to add new languages

New external formatters can be added easily if they can read code from standard input and format it to standard output. Feel free to submit a pull request or ask for help in GitHub issues.

How to report bugs

GitHub issues are preferred. Email is also ok.

Feature requests are welcome. If you are interested in doing anything beyong just adding new formatters in the current framework, please discuss in issues before writing code, since there are big unresolved questions about where the project should go from here.

Roadmap

atom-beautify sports a very impressive set of formatters. We should aspire to that level of coverage for Emacs.

Unibeautify is a project to provide one shell command to run all beautifiers. atom-beautify will be rewritten to be based on it. Perhaps we should be too, once it stabilizes.

You can’t perform that action at this time.