Add user input log, playback and transcript

[mslinn]

Logging

Input Log

The input log would only contain what the user typed, without the evaluated responses; it would be stored in a file called ${USER}_yyyy-mm-dd-HH-MM-ss.log.

To see what ${USER} expands to on your computer, type the following into a bash-compatible shell:

echo ${USER}

The directory to write the input log to defaults to ~/$productName/log, but this can be overridden by using the --log-directory command-line switch. For example:

bin/run --log-directory /path/to/directory

Replay

• Add a new automatically defined command that plays back a user log.
• Add the --replay command-line switch to play back a use log.

bin/run --log-directory /path/to/directory --replay "${USER}_2017-10-31-12-34-56.log"

Transcript

The transcript would contain what the user typed and the evaluated responses; it would be stored in a file called $USER_yyyy-mm-dd-dd-HH-MM-ss.log.

The directory to write the transcript to defaults to ~/$productName/transcript, but this can be overridden by using the --transcript-directory command-line switch. For example:

bin/run --transcript-directory /path/to/directory

Command-Line Switches

Users can control logging with the following command-line switches, specified when the program is launched:

--log-directory /path/to/directory - default is to log in ~/$productName/log
--no-log           - disable logging
--no-transcript  - disable transcript
--replay user_yyyy-mm-dd-HH-MM-ss  - log-directory can specify where to read from
--transcript-directory /path/to/directory - default is to log in ~/$productName/transcript

productName is specified in src/main/resources/reference.conf.