Stan.Cli

CLI commands and options for stan.

Documentation

data StanCommand

Commands used in Stan CLI.

Constructors

Stan !StanArgs

Just stan with its options.

StanInspection !InspectionArgs

stan inspection.

StanTomlToCli !TomlToCliArgs

stan toml-to-cli

StanCliToToml !CliToTomlArgs

stan cli-to-toml

StanInspectionsToMd

stan inspections-to-md

data StanArgs

Options used for the main stan command.

Constructors

StanArgs

Fields

• stanArgsHiedir :: !FilePath

  Directory with HIE files

• stanArgsCabalFilePath :: ![FilePath]

  Path to .cabal files.

• stanArgsOutputSettings :: !OutputSettings

  Settings for output terminal report

• stanArgsReport :: !(Maybe ReportArgs)

  HTML report settings

• stanArgsUseDefaultConfigFile :: !(TaggedTrial Text Bool)

  Use default .stan.toml file

• stanArgsConfigFile :: !(Maybe FilePath)

  Path to a custom configurations file.

• stanArgsConfig :: !PartialConfig
• stanArgsJsonOut :: !Bool

  Output the machine-readable output in JSON format instead.

newtype ReportArgs

Constructors

ReportArgs

Fields

• reportArgsBrowse :: Bool

  Open HTML report in a browser

newtype InspectionArgs

Options used for the stan inspection command.

Constructors

InspectionArgs

Fields

• inspectionArgsId :: Maybe (Id Inspection)

newtype TomlToCliArgs

Options used for the stan toml-to-cli command.

Constructors

TomlToCliArgs

Fields

• tomlToCliArgsFilePath :: Maybe FilePath

data CliToTomlArgs

Options used for the stan cli-to-toml command.

Constructors

CliToTomlArgs

Fields

• cliToTomlArgsFilePath :: !(Maybe FilePath)
• cliToTomlArgsConfig :: !PartialConfig

runStanCli :: IO StanCommand

Run main parser of the stan command line tool.

stanParserPrefs :: ParserPrefs

To turn on some special options.

stanCliParser :: ParserInfo StanCommand