Module pepper.report
Report script context. This module provides functions for the current program execution environment as well as report inspection and execution facilities.
Functions
| report:description () | Returns the report's description. |
| report:getopt (option, default) | Returns a command line option for the report script. |
| report:name () | Returns the report's name. |
| report:new (path, options) | Constructor. |
| report:options () | Returns the report's accepted options. |
| report:repository () | Returns the current repository. |
| report:run () | Runs this report. |
Functions
- report:description ()
- Returns the report's description.
- report:getopt (option, default)
-
Returns a command line option for the report script.
Parameters
- option: The command line flags, separated with commas
- default: An optional default option value
- report:name ()
- Returns the report's name.
- report:new (path, options)
-
Constructor.
Parameters
- path: The report script path
- options: Optional table of report options. If not given, the options of the current report will be used.
- report:options ()
-
Returns the report's accepted options.
Return value:
A table with 2 entries per option (synopsis and description). - report:repository ()
-
Returns the current repository.
Return value:
A repository instanceSee also:
- report:run ()
-
Runs this report. This function is similar to pepper.run(), except that is uses this report context instead of constructing a new one
See also: