Skip to content

Commit

Permalink
Update README.md with missing languages
Browse files Browse the repository at this point in the history
Also sort lists, document which filetypes support Prettier, and match
the AutoFormatBuffer example to the language list.
  • Loading branch information
flwyd authored and dbarnett committed Jan 13, 2024
1 parent c6730fb commit 6fa1616
Showing 1 changed file with 64 additions and 49 deletions.
113 changes: 64 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,53 @@
[![Travis Build Status](https://travis-ci.org/google/vim-codefmt.svg?branch=master)](https://travis-ci.org/google/vim-codefmt)

codefmt is a utility for syntax-aware code formatting. It contains several
codefmt is a utility for syntax-aware code formatting. It contains several
built-in formatters, and allows new formatters to be registered by other
plugins.

For details, see the executable documentation in the `vroom/` directory or the
helpfiles in the `doc/` directory. The helpfiles are also available via
`:help codefmt` if codefmt is installed (and helptags have been generated).
helpfiles in the `doc/` directory. The helpfiles are also available via `:help
codefmt` if codefmt is installed (and helptags have been generated).

# Supported File-types

* [Bazel](https://www.github.com/bazelbuild/bazel) BUILD files (buildifier)
* C, C++ (clang-format)
* [Clojure](https://clojure.org/) ([zprint](https://github.com/kkinnear/zprint),
[cljstyle](https://github.com/greglook/cljstyle))
* CSS, Sass, SCSS, Less (js-beautify)
* Dart (dartfmt)
* Fish ([fish_indent](https://fishshell.com/docs/current/commands.html#fish_indent))
* Go (gofmt)
* [GN](https://www.chromium.org/developers/gn-build-configuration) (gn)
* Haskell ([ormolu](https://github.com/tweag/ormolu))
* HTML (js-beautify)
* Java (google-java-format or clang-format)
* JavaScript (clang-format or [prettier](https://prettier.io))
* JSON (js-beautify)
* Kotlin ([ktfmt](https://github.com/facebookincubator/ktfmt))
* OCaml ([ocamlformat](https://github.com/ocaml-ppx/ocamlformat))
* Proto (clang-format)
* Python (Autopep8, Black, or YAPF)
* Ruby ([rubocop](https://rubocop.org))
* Rust ([rustfmt](https://github.com/rust-lang/rustfmt))
* TypeScript (clang-format)
* Shell (shfmt)
* [Vue](http://vuejs.org) (prettier)
* Nix (nixpkgs-fmt)
* Swift ([swift-format](https://github.com/apple/swift-format))
* [Bazel](https://www.github.com/bazelbuild/bazel) BUILD files (buildifier)
* C, C++ (clang-format)
* [Clojure](https://clojure.org/)
([zprint](https://github.com/kkinnear/zprint),
[cljstyle](https://github.com/greglook/cljstyle))
* CSS, Sass, SCSS, Less (js-beautify, prettier)
* Dart (dartfmt)
* Elixir ([`mix format`](https://hexdocs.pm/mix/main/Mix.Tasks.Format.html))
* Fish
([fish_indent](https://fishshell.com/docs/current/commands.html#fish_indent))
* [GN](https://www.chromium.org/developers/gn-build-configuration) (gn)
* Go (gofmt)
* Haskell ([ormolu](https://github.com/tweag/ormolu))
* HTML (js-beautify, prettier)
* Java (google-java-format or clang-format)
* JavaScript (clang-format, js-beautify, or [prettier](https://prettier.io))
* JSON (js-beautify)
* Jsonnet ([jsonnetfmt](https://jsonnet.org/learning/tools.html))
* Julia ([JuliaFormatter](https://github.com/domluna/JuliaFormatter.jl))
* Kotlin ([ktfmt](https://github.com/facebookincubator/ktfmt))
* Lua
([FormatterFiveOne](https://luarocks.org/modules/ElPiloto/formatterfiveone)
* Markdown (prettier)
* Nix (nixpkgs-fmt)
* OCaml ([ocamlformat](https://github.com/ocaml-ppx/ocamlformat))
* Protocol Buffers (clang-format)
* Python (Autopep8, Black, isort, or YAPF)
* Ruby ([rubocop](https://rubocop.org))
* Rust ([rustfmt](https://github.com/rust-lang/rustfmt))
* Shell (shfmt)
* Swift ([swift-format](https://github.com/apple/swift-format))
* TypeScript (clang-format)
* [Vue](http://vuejs.org) (prettier)

# Commands

Use `:FormatLines` to format a range of lines or use `:FormatCode` to format
the entire buffer. Use `:NoAutoFormatBuffer` to disable current buffer
formatting.
Use `:FormatLines` to format a range of lines or use `:FormatCode` to format the
entire buffer. Use `:NoAutoFormatBuffer` to disable current buffer formatting.

# Usage example

Expand Down Expand Up @@ -78,8 +85,8 @@ Glaive codefmt plugin[mappings]
Glaive codefmt google_java_executable="java -jar /path/to/google-java-format-VERSION-all-deps.jar"
```

Make sure you have updated maktaba recently. Codefmt depends upon maktaba
to register formatters.
Make sure you have updated maktaba recently. Codefmt depends upon maktaba to
register formatters.

# Autoformatting

Expand All @@ -89,27 +96,38 @@ Want to just sit back and let autoformat happen automatically? Add this to your
```vim
augroup autoformat_settings
autocmd FileType bzl AutoFormatBuffer buildifier
autocmd FileType c,cpp,proto,javascript,arduino AutoFormatBuffer clang-format
autocmd FileType c,cpp,proto,javascript,typescript,arduino AutoFormatBuffer clang-format
autocmd FileType clojure AutoFormatBuffer cljstyle
autocmd FileType dart AutoFormatBuffer dartfmt
autocmd FileType go AutoFormatBuffer gofmt
autocmd FileType elixir,eelixir,heex AutoFormatBuffer mixformat
autocmd FileType fish AutoFormatBuffer fish_indent
autocmd FileType gn AutoFormatBuffer gn
autocmd FileType go AutoFormatBuffer gofmt
autocmd FileType haskell AutoFormatBuffer ormolu
" Alternative for web languages: prettier
autocmd FileType html,css,sass,scss,less,json AutoFormatBuffer js-beautify
autocmd FileType java AutoFormatBuffer google-java-format
autocmd FileType jsonnet AutoFormatBuffer jsonnetfmt
autocmd FileType julia AutoFormatBuffer JuliaFormatter
autocmd FileType kotlin AutoFormatBuffer ktfmt
autocmd FileType lua AutoFormatBuffer luaformatterfiveone
autocmd FileType markdown AutoFormatBuffer prettier
autocmd FileType ocaml AutoFormatBuffer ocamlformat
autocmd FileType python AutoFormatBuffer yapf
" Alternative: autocmd FileType python AutoFormatBuffer autopep8
autocmd FileType ruby AutoFormatBuffer rubocop
autocmd FileType rust AutoFormatBuffer rustfmt
autocmd FileType vue AutoFormatBuffer prettier
autocmd FileType swift AutoFormatBuffer swift-format
autocmd FileType vue AutoFormatBuffer prettier
augroup END
```

# Configuring formatters

Most formatters have some options available that can be configured via
[Glaive](https://www.github.com/google/vim-glaive)
You can get a quick view of all codefmt flags by executing `:Glaive codefmt`, or
start typing flag names and use tab completion. See `:help Glaive` for usage
details.
[Glaive](https://www.github.com/google/vim-glaive) You can get a quick view of
all codefmt flags by executing `:Glaive codefmt`, or start typing flag names and
use tab completion. See `:help Glaive` for usage details.

# Installing formatters

Expand All @@ -127,25 +145,22 @@ vroom/FORMATTER-NAME.vroom to learn more about usage for individual formatters.
## Creating a New Formatter

Assume a filetype `myft` and a formatter called `MyFormatter`. Our detailed
guide to creating a formatter [lives
here](https://github.com/google/vim-codefmt/wiki/Formatter-Integration-Guide).
guide to creating a formatter
[lives here](https://github.com/google/vim-codefmt/wiki/Formatter-Integration-Guide).

* Create an issue for your new formatter and discuss!

* Create a new file in `autoload/codefmt/myformatter.vim` See
`autoload/codefmt/buildifier.vim for an example. This is where all the
logic for formatting goes.
`autoload/codefmt/buildifier.vim for an example. This is where all the logic
for formatting goes.

* Register the formatter in
[plugin/register.vim](plugin/register.vim)
with:
* Register the formatter in [plugin/register.vim](plugin/register.vim) with:

```vim
call s:registry.AddExtension(codefmt#myformatter#GetFormatter())
```
* Create a flag in
[instant/flags.vim](instant/flags.vim)
* Create a flag in [instant/flags.vim](instant/flags.vim)
```vim
""
Expand Down

0 comments on commit 6fa1616

Please sign in to comment.