ligo/src/bin/expect_tests/help_tests.ml
2020-02-09 18:22:33 +01:00

551 lines
21 KiB
OCaml

open Cli_expect
let%expect_test _ =
(* TODO good? *)
run_ligo_good [] ;
[%expect {|
NAME
ligo
SYNOPSIS
ligo COMMAND ...
MORE HELP
Use `ligo COMMAND --help' for help on a single command.
COMMANDS
changelog
Dump the LIGO changelog to stdout.
compile-contract
Subcommand: Compile a contract.
compile-expression
Subcommand: Compile to a michelson value.
compile-parameter
Subcommand: Compile parameters to a Michelson expression. The
resulting Michelson expression can be passed as an argument in a
transaction which calls a contract.
compile-storage
Subcommand: Compile an initial storage in ligo syntax to a
Michelson expression. The resulting Michelson expression can be
passed as an argument in a transaction which originates a
contract.
dry-run
Subcommand: Run a smart-contract with the given storage and input.
evaluate-value
Subcommand: Evaluate a given definition.
interpret
Subcommand: Interpret the expression in the context initialized by
the provided source file.
ligo-interpret
Subcommand: (temporary / dev only) uses LIGO interpret.
list-declarations
Subcommand: List all the top-level declarations.
measure-contract
Subcommand: Measure a contract's compiled size in bytes.
print-ast
Subcommand: Print the AST. Warning: Intended for development of
LIGO and can break at any time.
print-cst
Subcommand: Print the CST. Warning: Intended for development of
LIGO and can break at any time.
print-mini-c
Subcommand: Print Mini-C. Warning: Intended for development of
LIGO and can break at any time.
print-typed-ast
Subcommand: Print the typed AST. Warning: Intended for development
of LIGO and can break at any time.
run-function
Subcommand: Run a function with the given parameter.
OPTIONS
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--version
Show version information. |} ] ;
run_ligo_good [ "--help" ] ;
[%expect {|
NAME
ligo
SYNOPSIS
ligo COMMAND ...
MORE HELP
Use `ligo COMMAND --help' for help on a single command.
COMMANDS
changelog
Dump the LIGO changelog to stdout.
compile-contract
Subcommand: Compile a contract.
compile-expression
Subcommand: Compile to a michelson value.
compile-parameter
Subcommand: Compile parameters to a Michelson expression. The
resulting Michelson expression can be passed as an argument in a
transaction which calls a contract.
compile-storage
Subcommand: Compile an initial storage in ligo syntax to a
Michelson expression. The resulting Michelson expression can be
passed as an argument in a transaction which originates a
contract.
dry-run
Subcommand: Run a smart-contract with the given storage and input.
evaluate-value
Subcommand: Evaluate a given definition.
interpret
Subcommand: Interpret the expression in the context initialized by
the provided source file.
ligo-interpret
Subcommand: (temporary / dev only) uses LIGO interpret.
list-declarations
Subcommand: List all the top-level declarations.
measure-contract
Subcommand: Measure a contract's compiled size in bytes.
print-ast
Subcommand: Print the AST. Warning: Intended for development of
LIGO and can break at any time.
print-cst
Subcommand: Print the CST. Warning: Intended for development of
LIGO and can break at any time.
print-mini-c
Subcommand: Print Mini-C. Warning: Intended for development of
LIGO and can break at any time.
print-typed-ast
Subcommand: Print the typed AST. Warning: Intended for development
of LIGO and can break at any time.
run-function
Subcommand: Run a function with the given parameter.
OPTIONS
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--version
Show version information. |} ] ;
run_ligo_good [ "compile-contract" ; "--help" ] ;
[%expect {|
NAME
ligo-compile-contract - Subcommand: Compile a contract.
SYNOPSIS
ligo compile-contract [OPTION]... SOURCE_FILE ENTRY_POINT
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
OPTIONS
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--michelson-format=MICHELSON_FORMAT (absent=text)
MICHELSON_FORMAT is the format that will be used by
compile-contract for the resulting Michelson. Available formats
are 'text' (default), 'json' and 'hex'.
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--version
Show version information. |} ] ;
run_ligo_good [ "compile-parameter" ; "--help" ] ;
[%expect {|
NAME
ligo-compile-parameter - Subcommand: Compile parameters to a Michelson
expression. The resulting Michelson expression can be passed as an
argument in a transaction which calls a contract.
SYNOPSIS
ligo compile-parameter [OPTION]... SOURCE_FILE ENTRY_POINT
PARAMETER_EXPRESSION
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
PARAMETER_EXPRESSION (required)
PARAMETER_EXPRESSION is the expression that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
OPTIONS
--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use.
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--michelson-format=MICHELSON_FORMAT (absent=text)
MICHELSON_FORMAT is the format that will be used by
compile-contract for the resulting Michelson. Available formats
are 'text' (default), 'json' and 'hex'.
--predecessor-timestamp=PREDECESSOR_TIMESTAMP
PREDECESSOR_TIMESTAMP is the predecessor_timestamp (now value
minus one minute) the Michelson interpreter will use (e.g.
'2000-01-01T10:10:10Z')
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will
use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will
use.
--version
Show version information. |} ] ;
run_ligo_good [ "compile-storage" ; "--help" ] ;
[%expect {|
NAME
ligo-compile-storage - Subcommand: Compile an initial storage in ligo
syntax to a Michelson expression. The resulting Michelson expression
can be passed as an argument in a transaction which originates a
contract.
SYNOPSIS
ligo compile-storage [OPTION]... SOURCE_FILE ENTRY_POINT
STORAGE_EXPRESSION
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
STORAGE_EXPRESSION (required)
STORAGE_EXPRESSION is the expression that will be compiled.
OPTIONS
--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use.
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--michelson-format=MICHELSON_FORMAT (absent=text)
MICHELSON_FORMAT is the format that will be used by
compile-contract for the resulting Michelson. Available formats
are 'text' (default), 'json' and 'hex'.
--predecessor-timestamp=PREDECESSOR_TIMESTAMP
PREDECESSOR_TIMESTAMP is the predecessor_timestamp (now value
minus one minute) the Michelson interpreter will use (e.g.
'2000-01-01T10:10:10Z')
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will
use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will
use.
--version
Show version information. |} ] ;
run_ligo_good [ "dry-run" ; "--help" ] ;
[%expect {|
NAME
ligo-dry-run - Subcommand: Run a smart-contract with the given storage
and input.
SYNOPSIS
ligo dry-run [OPTION]... SOURCE_FILE ENTRY_POINT PARAMETER_EXPRESSION
STORAGE_EXPRESSION
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
PARAMETER_EXPRESSION (required)
PARAMETER_EXPRESSION is the expression that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
STORAGE_EXPRESSION (required)
STORAGE_EXPRESSION is the expression that will be compiled.
OPTIONS
--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use.
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--predecessor-timestamp=PREDECESSOR_TIMESTAMP
PREDECESSOR_TIMESTAMP is the predecessor_timestamp (now value
minus one minute) the Michelson interpreter will use (e.g.
'2000-01-01T10:10:10Z')
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will
use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will
use.
--version
Show version information. |} ] ;
run_ligo_good [ "run-function" ; "--help" ] ;
[%expect {|
NAME
ligo-run-function - Subcommand: Run a function with the given
parameter.
SYNOPSIS
ligo run-function [OPTION]... SOURCE_FILE ENTRY_POINT
PARAMETER_EXPRESSION
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
PARAMETER_EXPRESSION (required)
PARAMETER_EXPRESSION is the expression that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
OPTIONS
--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use.
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--predecessor-timestamp=PREDECESSOR_TIMESTAMP
PREDECESSOR_TIMESTAMP is the predecessor_timestamp (now value
minus one minute) the Michelson interpreter will use (e.g.
'2000-01-01T10:10:10Z')
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will
use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will
use.
--version
Show version information. |} ] ;
run_ligo_good [ "evaluate-value" ; "--help" ] ;
[%expect {|
NAME
ligo-evaluate-value - Subcommand: Evaluate a given definition.
SYNOPSIS
ligo evaluate-value [OPTION]... SOURCE_FILE ENTRY_POINT
ARGUMENTS
ENTRY_POINT (required)
ENTRY_POINT is entry-point that will be compiled.
SOURCE_FILE (required)
SOURCE_FILE is the path to the smart contract file.
OPTIONS
--amount=AMOUNT (absent=0)
AMOUNT is the amount the Michelson interpreter will use.
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--predecessor-timestamp=PREDECESSOR_TIMESTAMP
PREDECESSOR_TIMESTAMP is the predecessor_timestamp (now value
minus one minute) the Michelson interpreter will use (e.g.
'2000-01-01T10:10:10Z')
-s SYNTAX, --syntax=SYNTAX (absent=auto)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
--sender=SENDER
SENDER is the sender the Michelson interpreter transaction will
use.
--source=SOURCE
SOURCE is the source the Michelson interpreter transaction will
use.
--version
Show version information. |} ] ;
run_ligo_good [ "compile-expression" ; "--help" ] ;
[%expect {|
NAME
ligo-compile-expression - Subcommand: Compile to a michelson value.
SYNOPSIS
ligo compile-expression [OPTION]... SYNTAX _EXPRESSION
ARGUMENTS
_EXPRESSION (required)
_EXPRESSION is the expression that will be compiled.
SYNTAX (required)
SYNTAX is the syntax that will be used. Currently supported
syntaxes are "pascaligo", "cameligo" and "reasonligo". By default,
the syntax is guessed from the extension (.ligo, .mligo, .religo
respectively).
OPTIONS
--format=DISPLAY_FORMAT, --display-format=DISPLAY_FORMAT
(absent=human-readable)
DISPLAY_FORMAT is the format that will be used by the CLI.
Available formats are 'dev', 'json', and 'human-readable'
(default). When human-readable lacks details (we are still
tweaking it), please contact us and use another format in the
meanwhile.
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of `auto',
`pager', `groff' or `plain'. With `auto', the format is `pager` or
`plain' whenever the TERM env var is `dumb' or undefined.
--michelson-format=MICHELSON_FORMAT (absent=text)
MICHELSON_FORMAT is the format that will be used by
compile-contract for the resulting Michelson. Available formats
are 'text' (default), 'json' and 'hex'.
--version
Show version information. |} ] ;