The omnifmt package

[Tags:bsd3, library, program]

omnifmt automatically formats code via external pretty-printers. The idea was taken from gofmt, just with a bit of expansion to more languages.


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.2.0.0, 0.2.0.1, 0.2.1.0, 0.2.1.1
Change log CHANGELOG.md
Dependencies aeson (>=0.8), base (>=4.8 && <5), exceptions (>=0.8), extra (>=1.4), fast-logger (>=2.4), filepath (>=1.4), monad-logger (>=0.3), monad-parallel (>=0.7), mtl (>=2.2), omnifmt, optparse-applicative (>=0.11 && <0.13), pipes (>=4.1), pipes-concurrency (>=2.0), temporary (>=1.2), text (>=1.2), time (>=1.5), unordered-containers (>=0.2), yaml (>=0.8) [details]
License BSD3
Author Henry J. Wylde
Maintainer public@hjwylde.com
Category Development
Home page https://github.com/hjwylde/omnifmt
Source repository head: git clone git@github.com:hjwylde/omnifmt
Uploaded Wed Dec 9 10:08:57 UTC 2015 by hjwylde
Updated Mon Sep 26 08:48:37 UTC 2016 by phadej to revision 1
Distributions NixOS:0.2.1.1
Downloads 418 total (43 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2015-12-09 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for omnifmt

Readme for omnifmt-0.2.1.1

omnifmt

Project Status: Wip - Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Build Status Release omnifmt on Stackage LTS omnifmt on Stackage Nightly

A pretty-printer wrapper to faciliate ease of formatting during development. omnifmt automatically formats code via external pretty-printers. The idea was taken from gofmt, just with a bit of expansion to more languages.

Formatted code is:

  • Easier to write: never worry about minor formatting concerns while hacking away.
  • Easier to read: when all code looks the same you need not mentally convert others' formatting style into something you can understand.
  • Easier to maintain: mechanical changes to the source don't cause unrelated changes to the file's formatting; diffs show only the real changes.
  • Uncontroversial: never have a debate about spacing or brace position ever again.

(Bullet points taken from https://blog.golang.org/go-fmt-your-code.)

Installing

Installing omnifmt is easiest done using either stack (recommended) or Cabal.

Using stack:

stack install omnifmt
export PATH=$PATH:~/.local/bin

Using Cabal:

cabal-install omnifmt
export PATH=$PATH:~/.cabal/bin

Usage

The omnifmt binary provides an interface for selecting files and piping them through external pretty-printers. It supports both prettifying the files immediately and performing dry-runs to see which files are ugly.

The basics:

By default omnifmt formats on all files found from the root directory; the root directory is the first parent directory with an '.omnifmt.yaml' config file.

Passing arguments to omnifmt will override this and only operate on the given files and directories.

Modes:

omnifmt can run in three different modes, normal, dry-run and diff.

Normal mode writes to (prettifies) all ugly files immediately and outputs the prettified file paths to stdout.

Dry-run mode outputs the ugly file paths to stdout.

Diff mode outputs a diff of all ugly files with their prettified version.

Configuration

Configuration is done via an '.omnifmt.yaml' file in the root directory. The file contains a list of programs that link extensions to a prettifying command, e.g.,

haskell:
    extensions: ["hs", "lhs"]
    command:    "stylish-haskell {{input}} > {{output}}"

javascript:
    extensions: ["js"]
    command:    "js-beautify -f {{input}}"

json:
    extensions: ["json"]
    command:    "json_pp"

ruby:
    extensions: ["rb"]
    command:    "ruby-beautify"

Each command declares how to read the input file and how to write to the output file. If the input variable is omitted, the file contents are fed to the command through stdin. Likewise if the output variable is omitted, the pretty contents are read from stdout. The output file is used to compare whether the original was pretty or ugly before writing to it.

The extensions field is pretty self explanatory, but if you use the same extension more than once then precedence goes to the program defined first.

Examples

See the docs/example-configs/ directory for some common pretty-printers and their corresponding omnifmt config (pull requests are welcome for adding more). Just don't forget to actually call the config file '.omnifmt.yaml'!

NB: I haven't tested them fully, be careful in case one is buggy.

Auto-completion

Add the following (depending on your shell) to include support for auto-completion.

Bash:

source <(omnifmt --bash-completion-script `which omnifmt`)

zsh:

autoload -Uz bashcompinit && bashcompinit
source <(omnifmt --bash-completion-script `which omnifmt`)