1. Getting Started with GNATformat

1.1. Prerequisites

a GNAT Pro installation (the most recent installed on the system) should be present in your $PATH

1.2. GNATformat setup

(on Windows) run the installer, and place <install_prefix>/bin in your $PATH

(on *NIX) extract the installation directory from the archive, and place <install_prefix>/bin in your $PATH

1.3. The 5-lines manual to GNATformat

GNATformat is an opinionated code formatter for the Ada language. It is based on the Prettier Ada library, a port of the Prettier formatter engine to the Ada programming language. These two projects are available on GitHub

Prettier Ada library: https://github.com/AdaCore/prettier-ada

Prettier: https://github.com/prettier/prettier

The intent of this tool is to format a valid Ada source code according to the coding style described in the GNAT Coding Style guide available online at https://gcc.gnu.org/onlinedocs/gnat-style.pdf

For more information about the tool, the full manual is available at

in your installation folder, under <install_prefix>/share/doc/gnatformat/html <install_prefix>/share/doc/gnatformat/pdf

online, at https://docs.adacore.com/live/wave/gnatformat/html/user-guide/index.html