Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sort options in command help messages #642

Merged
merged 2 commits into from
Dec 28, 2024
+60 −59
Merged

Sort options in command help messages #642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f93622
fix(eo-phi-normalizer): sort options in command help messages
deemp Dec 16, 2024
ccb920b
chore(ci): Update Markdown files
github-actions[bot] Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions eo-phi-normalizer/app/Main.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,47 +283,47 @@ commandParser =
CommandParser{..}
where
metrics = do
inputFile <- inputFileArg
outputFile <- outputFileOption
bindingsPath <- bindingsPathOption
outputFile <- outputFileOption
inputFile <- inputFileArg
pure CLI'MetricsPhi{..}
printRules = do
compact <- compactSwitch
rulesPath <- optional $ strOption (long "rules" <> short 'r' <> metavar.file <> help [fmt|{metavarName.file} with user-defined rules. If unspecified, {rulesFile} is rendered.|])
latex <- latexSwitch
compact <- compactSwitch
pure CLI'PrintRules{..}
rewrite = do
rulesPath <- optional $ strOption (long "rules" <> short 'r' <> metavar.file <> help [fmt|{metavarName.file} with user-defined rules. If unspecified, builtin set of rules is used.|])
chain <- switch (long "chain" <> short 'c' <> help "Output rewriting steps.")
dependencies <- dependenciesArg
json <- jsonSwitch
latex <- latexSwitch
outputFile <- outputFileOption
let singleFlag :: String
singleFlag = "single"
single <- switch (long singleFlag <> short 's' <> help "Output a single expression.")
singleLine <- switch (long "single-line" <> short 'l' <> help [fmt|Output a single expression on a single line. Has effect only if the --{singleFlag} is enabled.|])
maxDepth <-
let maxValue = 10
in option auto (long "max-depth" <> metavar.int <> value maxValue <> help [fmt|Maximum depth of rules application. Defaults to {maxValue}.|])
maxGrowthFactor <-
let maxValue = 10
in option auto (long "max-growth-factor" <> metavar.int <> value maxValue <> help [fmt|The factor by which to allow the input term to grow before stopping. Defaults to {maxValue}.|])
outputFile <- outputFileOption
rulesPath <- optional $ strOption (long "rules" <> short 'r' <> metavar.file <> help [fmt|{metavarName.file} with user-defined rules. If unspecified, builtin set of rules is used.|])
let singleFlag :: String
singleFlag = "single"
single <- switch (long singleFlag <> short 's' <> help "Output a single expression.")
singleLine <- switch (long "single-line" <> short 'l' <> help [fmt|Output a single expression on a single line. Has effect only if the --{singleFlag} is enabled.|])
latex <- latexSwitch
inputFile <- inputFileArg
dependencies <- dependenciesArg
pure CLI'RewritePhi{..}
dataize = do
rulesPath <- optional $ strOption (long "rules" <> short 'r' <> metavar.file <> help [fmt|{metavarName.file} with user-defined rules. If unspecified, builtin set of rules is used.|])
inputFile <- inputFileArg
asPackage <- asPackageSwitch
chain <- switch (long "chain" <> help "Display all the intermediate steps.")
dependencies <- dependenciesArg
disabledAtomNames <- many $ strOption (long "disable-atom" <> metavar.atomName <> help "Name of an atom to disable.")
enabledAtomNames <- many $ strOption (long "enable-atom" <> metavar.atomName <> help "Name of an atom to enable.")
minimizeStuckTerms <- minimizeStuckTermsSwitch
outputFile <- outputFileOption
recursive <- switch (long "recursive" <> help "Apply dataization + normalization recursively.")
chain <- switch (long "chain" <> help "Display all the intermediate steps.")
wrapRawBytes <- switch (long "wrap-raw-bytes" <> help "Wrap raw bytes ⟦ Δ ⤍ 01- ⟧ as Φ.org.eolang.bytes(Δ ⤍ 01-) in the final output.")
rulesPath <- optional $ strOption (long "rules" <> short 'r' <> metavar.file <> help [fmt|{metavarName.file} with user-defined rules. If unspecified, builtin set of rules is used.|])
latex <- latexSwitch
asPackage <- asPackageSwitch
minimizeStuckTerms <- minimizeStuckTermsSwitch
disabledAtomNames <- many $ strOption (long "disable-atom" <> metavar.atomName <> help "Name of an atom to disable.")
enabledAtomNames <- many $ strOption (long "enable-atom" <> metavar.atomName <> help "Name of an atom to enable.")
wrapRawBytes <- switch (long "wrap-raw-bytes" <> help "Wrap raw bytes ⟦ Δ ⤍ 01- ⟧ as Φ.org.eolang.bytes(Δ ⤍ 01-) in the final output.")
inputFile <- inputFileArg
pure CLI'DataizePhi{..}
pipeline' =
CommandParser'Pipeline
Expand All @@ -335,8 +335,8 @@ commandParser =
pure CLI'Pipeline'PrepareTests{..}
, printDataizeConfigs = do
configFile <- strOption (long "config" <> short 'c' <> metavar.file <> help [fmt|A pipeline tests configuration {metavarName.file}.|])
phiPrefixesToStrip <- many $ strOption (long "strip-phi-prefix" <> short 'p' <> metavar.path <> help [fmt|{metavarName.path} prefix to remove in PHI file paths.|])
singleLine <- switch (long "single-line" <> short 'l' <> help [fmt|Output configs on an single line.|])
phiPrefixesToStrip <- many $ strOption (long "strip-phi-prefix" <> short 'p' <> metavar.path <> help [fmt|{metavarName.path} prefix to remove in PHI file paths.|])
pure CLI'Pipeline'PrintDataizeConfigs{..}
}
pipeline =
Expand Down
35 changes: 18 additions & 17 deletions site/docs/src/eo-phi-normalizer/dataize.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,38 +13,39 @@ eo-phi-normalizer dataize --help
```

```console
Usage: eo-phi-normalizer dataize [-r|--rules FILE] [FILE]
Usage: eo-phi-normalizer dataize [--as-package] [--chain]
[-d|--dependency-file FILE]
[-o|--output-file FILE] [--recursive] [--chain]
[--wrap-raw-bytes] [--tex] [--as-package]
[--minimize-stuck-terms]
[--disable-atom ATOM_NAME]
[--enable-atom ATOM_NAME]
[--minimize-stuck-terms]
[-o|--output-file FILE] [--recursive]
[-r|--rules FILE] [--tex] [--wrap-raw-bytes]
[FILE]

Dataize a PHI program.

Available options:
-r,--rules FILE FILE with user-defined rules. If unspecified, builtin
set of rules is used.
FILE FILE to read input from. When no FILE is specified,
read from stdin.
--as-package Automatically inject (λ → Package) in the program if
necessary, to dataize all fields.
--chain Display all the intermediate steps.
-d,--dependency-file FILE
FILE to read dependencies from (zero or more
dependency files allowed).
--disable-atom ATOM_NAME Name of an atom to disable.
--enable-atom ATOM_NAME Name of an atom to enable.
--minimize-stuck-terms If a dataized (sub)term is stuck (cannot be fully
dataized), use the minimal (by size) intermediate
result.
-o,--output-file FILE Output to FILE. When this option is not specified,
output to stdout.
--recursive Apply dataization + normalization recursively.
--chain Display all the intermediate steps.
-r,--rules FILE FILE with user-defined rules. If unspecified, builtin
set of rules is used.
--tex Output LaTeX.
--wrap-raw-bytes Wrap raw bytes ⟦ Δ ⤍ 01- ⟧ as Φ.org.eolang.bytes(Δ ⤍
01-) in the final output.
--tex Output LaTeX.
--as-package Automatically inject (λ → Package) in the program if
necessary, to dataize all fields.
--minimize-stuck-terms If a dataized (sub)term is stuck (cannot be fully
dataized), use the minimal (by size) intermediate
result.
--disable-atom ATOM_NAME Name of an atom to disable.
--enable-atom ATOM_NAME Name of an atom to enable.
FILE FILE to read input from. When no FILE is specified,
read from stdin.
-h,--help Show this help text
```

Expand Down
12 changes: 6 additions & 6 deletions site/docs/src/eo-phi-normalizer/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ eo-phi-normalizer metrics --help
```

```console
Usage: eo-phi-normalizer metrics [FILE] [-o|--output-file FILE]
[-b|--bindings-path PATH]
Usage: eo-phi-normalizer metrics [-b|--bindings-path PATH]
[-o|--output-file FILE] [FILE]

Collect metrics for a PHI program.

Available options:
FILE FILE to read input from. When no FILE is specified,
read from stdin.
-o,--output-file FILE Output to FILE. When this option is not specified,
output to stdout.
-b,--bindings-path PATH Report metrics for bindings of a formation accessible
in a program by the PATH. When this option is not
specified, metrics for bindings are not reported.
Example of a PATH: 'org.eolang'.
-o,--output-file FILE Output to FILE. When this option is not specified,
output to stdout.
FILE FILE to read input from. When no FILE is specified,
read from stdin.
-h,--help Show this help text
```

Expand Down
4 changes: 2 additions & 2 deletions site/docs/src/eo-phi-normalizer/print-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ eo-phi-normalizer print-rules --help
```

```console
Usage: eo-phi-normalizer print-rules [-r|--rules FILE] [--tex] [-c|--compact]
Usage: eo-phi-normalizer print-rules [-c|--compact] [-r|--rules FILE] [--tex]

Print rules in LaTeX format.

Available options:
-c,--compact Print rules, each on a single line.
-r,--rules FILE FILE with user-defined rules. If unspecified,
yegor.yaml is rendered.
--tex Output LaTeX.
-c,--compact Print rules, each on a single line.
-h,--help Show this help text
```

Expand Down
28 changes: 14 additions & 14 deletions site/docs/src/eo-phi-normalizer/rewrite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,33 +21,33 @@ eo-phi-normalizer rewrite --help
```

```console
Usage: eo-phi-normalizer rewrite [-r|--rules FILE] [-c|--chain] [-j|--json]
[--tex] [-o|--output-file FILE] [-s|--single]
[-l|--single-line] [--max-depth INT]
[--max-growth-factor INT] [FILE]
[-d|--dependency-file FILE]
Usage: eo-phi-normalizer rewrite [-c|--chain] [-d|--dependency-file FILE]
[-j|--json] [--max-depth INT]
[--max-growth-factor INT]
[-o|--output-file FILE] [-r|--rules FILE]
[-s|--single] [-l|--single-line] [--tex] [FILE]

Rewrite a PHI program.

Available options:
-r,--rules FILE FILE with user-defined rules. If unspecified, builtin
set of rules is used.
-c,--chain Output rewriting steps.
-d,--dependency-file FILE
FILE to read dependencies from (zero or more
dependency files allowed).
-j,--json Output JSON.
--tex Output LaTeX.
--max-depth INT Maximum depth of rules application. Defaults to 10.
--max-growth-factor INT The factor by which to allow the input term to grow
before stopping. Defaults to 10.
-o,--output-file FILE Output to FILE. When this option is not specified,
output to stdout.
-r,--rules FILE FILE with user-defined rules. If unspecified, builtin
set of rules is used.
-s,--single Output a single expression.
-l,--single-line Output a single expression on a single line. Has
effect only if the --single is enabled.
--max-depth INT Maximum depth of rules application. Defaults to 10.
--max-growth-factor INT The factor by which to allow the input term to grow
before stopping. Defaults to 10.
--tex Output LaTeX.
FILE FILE to read input from. When no FILE is specified,
read from stdin.
-d,--dependency-file FILE
FILE to read dependencies from (zero or more
dependency files allowed).
-h,--help Show this help text
```

Expand Down