Forrest logo
back to the brittany tool

brittany:tldr:f886f

brittany: Format a Haskell source file according to the style defined in the specified config file.
$ brittany --config-file ${path-to-config-yaml} ${filename-hs}
try on your machine

The command you provided is using the command-line tool "brittany" with certain arguments. Here's the breakdown of the command:

  • "brittany": This is the name of the command-line tool that will be executed.
  • "--config-file": This flag specifies that a configuration file will be used for the formatting options.
  • "${path-to-config-yaml}": This is the placeholder for the path to the configuration file (in YAML format) that contains the desired formatting options. You need to replace "${path-to-config-yaml}" with the actual file path.
  • "${filename-hs}": This is the placeholder for the Haskell source code file that you want to format. You need to replace "${filename-hs}" with the actual file name.

In summary, the command executes the "brittany" tool and formats the Haskell source code file specified by ${filename-hs}, using the formatting options defined in the configuration file specified by ${path-to-config-yaml}.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the brittany tool