Forrest logo
back to the brittany tool

brittany:tldr:91970

brittany: Check whether a Haskell source file needs changes and indicate the result through the programme's exit code.
$ brittany --check-mode ${filename-hs}
try on your machine

This command is using a tool called "brittany" to check the formatting of a Haskell file (${filename-hs}).

The "brittany" tool is a code formatter for Haskell source code. It automatically formats the code according to a set of rules and coding conventions, making it more consistent and easier to read.

The "--check-mode" option is telling "brittany" to only check the formatting of the file, without making any changes to it. It will report any formatting violations but won't modify the file.

"${filename-hs}" is a placeholder for the actual name of the Haskell file you want to check. You need to replace it with the correct filename when using the command.

Overall, this command executes the "brittany" tool in "check mode" to verify the formatting of a Haskell file without making any changes to it.

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