ats-format-0.2.0.35: man/atsfmt.1

.\" Automatically generated by Pandoc 2.7.3
.\"
.TH "atsfmt (1)" "" "" "" ""
.hy
.SH NAME
.PP
atsfmt - a source code formatter for ATS
.SH SYNOPSIS
.PP
atsfmt <file>
.PP
atsfmt -i <file>
.PP
atsfmt --default-config
.PP
cat file.dats | atsfmt
.PP
atsfmt --default-config
.SH DESCRIPTION
.PP
\f[B]atsfmt\f[R] is an opinionated formatter for that ATS2 language.
.SH OPTIONS
.TP
.B \f[B]-h\f[R] \f[B]--help\f[R]
Display help
.TP
.B \f[B]-V\f[R] \f[B]--version\f[R]
Display version information
.TP
.B \f[B]-o\f[R] \f[B]--no-config\f[R]
Ignore configuration files in scope
.TP
.B \f[B]-i\f[R]
Modify a file in-place.
.TP
.B \f[B]--default-config\f[R]
Generate a default configuration file in the current directory
.SH CONFIGURATION
.PP
\f[B]atsfmt\f[R] is configured using a TOML file, by default
\&.atsfmt.toml.
You can generate a default configuration with
.IP
.nf
\f[C]
atsfmt --default-config
\f[R]
.fi
.PP
To make \f[B]atsfmt\f[R] call clang-format on embedded C code, add the
following to your .atsfmt.toml
.IP
.nf
\f[C]
clang-format = true
\f[R]
.fi
.PP
You can also set ribbon width and line width in the file, viz.
.IP
.nf
\f[C]
ribbon = 0.6
width = 120
\f[R]
.fi
.PP
Ribbon width is the width of a line excluding indentation.
In this example, the maximum column number will be 120 and the maximum
ribbon width will be 0.6 * 120 = 72 characters.
.SH EDITOR INTEGRATION
.PP
Editor integration is available with the ATS vim plugin at:
.PP
https://github.com/vmchale/ats-vim
.SH COPYRIGHT
.PP
Copyright 2017-2019.
Vanessa McHale.
All Rights Reserved.
.SH AUTHORS
Vanessa McHale<vamchale@gmail.com>.