Skip to main content

C_Runtime

Implementation of the runtime's command-line interface (CLI)

Status​

Experimental: Functionality may change for any reason, without semantic versioning guarantees

Availability​

This is a global namespace and can be accessed directly:

C_Runtime.PrintVersionString() -- Implicit global lookup: _G.C_Runtime

Functions​

DisplayHelpText​

Displays a text containing versioning information and some basic usage instructions for the runtime's command-line interface.

EvaluateString​

Evaluates the string value passed in as a Lua chunk and returns all results. Propagates any errors that may be encountered.

Available since: v0.0.1
Arguments
#NameTypeFallback
luaCodestring
Return values
#NameType
...varargs

PrintVersionString​

Displays the semantic version string identifying the build of the native runtime. The exact format is defined by git describe:

  • Tagged release: v0.0.1
  • Local build: v0.0.0-151
  • For details, see the git manual

The value displayed is also exported globally via EVO_VERSION and can thus be queried.

RunBasicTests​

Starts a bdd-style unit test runner in basic reporting mode with the given list of test files as input and returns the result.

Available since: v0.0.1
Arguments
#NameTypeFallback
specFilestable
Return values
#NameType
successboolean

RunDetailedTests​

Starts a bdd-style unit test runner in detailed reporting mode with the given list of test files as input and returns the result.

Available since: v0.0.1
Arguments
#NameTypeFallback
specFilestable
Return values
#NameType
successboolean

RunMinimalTests​

Starts a bdd-style unit test runner in minimal reporting mode with the given list of test files as input and returns the result.

Available since: v0.0.1
Arguments
#NameTypeFallback
specFilestable
Return values
#NameType
successboolean

Changelog​

VersionWhat happened?
v0.0.1Initial release