ats-format-0.2.0.27: man/atsfmt.1

.\" Automatically generated by Pandoc 2.2.1
.\"
.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 \[en]default\-config
.SH DESCRIPTION
.PP
\f[B]atsfmt\f[] is an opinionated formatter for that ATS2 language.
.SH OPTIONS
.TP
.B \f[B]\-h\f[] \f[B]\-\-help\f[]
Display help
.RS
.RE
.TP
.B \f[B]\-V\f[] \f[B]\-\-version\f[]
Display version information
.RS
.RE
.TP
.B \f[B]\-o\f[] \f[B]\-\-no\-config\f[]
Ignore configuration files in scope
.RS
.RE
.TP
.B \f[B]\-i\f[]
Modify a file in\-place.
.RS
.RE
.TP
.B \f[B]\-\-default\-config\f[]
Generate a default configuration file in the current directory
.RS
.RE
.SH CONFIGURATION
.PP
\f[B]atsfmt\f[] 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[]
.fi
.PP
To make \f[B]atsfmt\f[] call clang\-format on embedded C code, add the
following to your .atsfmt.toml
.IP
.nf
\f[C]
clang\-format\ =\ true
\f[]
.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[]
.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\-2018.
Vanessa McHale.
All Rights Reserved.
.SH AUTHORS
Vanessa McHale<vamchale@gmail.com>.