Skip to main content

Colored terminal demos

These deterministic recordings use the plugin's actual display controller. File events arrive at fixed intervals to make behavior reproducible; the timings illustrate process-wide metrics and do not measure individual file completion. Spinner frames advance with file events, replacing the previous progress block in an interactive terminal. Redirected output uses complete lines.

Animated GIFs follow the presentation used by eslint-plugin-file-progress-2. For a still image, see the static terminal poster. The casts preserve selectable terminal text and ANSI colors.

Jump to presets, options, or recording instructions. Choose a preset or review the option defaults while comparing output.

Presets​

Show each file using the default display options.

recommended terminal recording

Preset configuration · Terminal cast

Hide all plugin output when CI is exactly true.

recommended-ci terminal recording

Preset configuration · Terminal cast

Hide live output in CI while retaining the detailed process summary.

recommended-ci-detailed terminal recording

Preset configuration · Terminal cast

Announce generic activity once, without showing filenames.

recommended-compact terminal recording

Preset configuration · Terminal cast

Show filenames and the detailed process summary.

recommended-detailed terminal recording

Preset configuration · Terminal cast

Show only the final process summary.

recommended-summary-only terminal recording

Preset configuration · Terminal cast

Show output only when stderr is an interactive terminal.

recommended-tty terminal recording

Preset configuration · Terminal cast

The two CI recordings use CI=true; recommended-tty uses an interactive stderr stream.

Options​

Add these secondary options to the rule: rules: { "file-progress/activate": [true, options] }.

pathFormat​

Show basenames instead of relative paths.

{
 "pathFormat": "basename"
}

pathFormat terminal recording

Terminal cast

hideDirectoryNames​

The deprecated alias still selects basename paths; prefer pathFormat.

{
 "hideDirectoryNames": true
}

hideDirectoryNames terminal recording

Terminal cast

fileNameOnNewLine​

Put the filename on its own indented line.

{
 "fileNameOnNewLine": true
}

fileNameOnNewLine terminal recording

Terminal cast

hideFileName​

Announce activity once without listing filenames.

{
 "hideFileName": true
}

hideFileName terminal recording

Terminal cast

hidePrefix​

Remove the SFP label and prefix mark.

{
 "hidePrefix": true
}

hidePrefix terminal recording

Terminal cast

prefixMark​

Choose a custom prefix mark.

{
 "prefixMark": ">>"
}

prefixMark terminal recording

Terminal cast

successMark​

Choose the mark used with a zero process exit code.

{
 "successMark": "OK"
}

successMark terminal recording

Terminal cast

successMessage​

Customize the shutdown message.

{
 "successMessage": "Stylesheet pass finished."
}

successMessage terminal recording

Terminal cast

failureMark​

A nonzero process exit code selects red failure styling, without inventing problem totals.

{
 "failureMark": "FAIL",
 "detailedSuccess": true
}

failureMark terminal recording

Terminal cast

detailedSuccess​

Include observed files, elapsed process time, throughput, and exit code.

{
 "detailedSuccess": true
}

detailedSuccess terminal recording

Terminal cast

mode-compact​

Emit one activity notice, followed by the shutdown summary.

{
 "mode": "compact"
}

mode-compact terminal recording

Terminal cast

mode-summary-only​

Wait until process exit before displaying the summary.

{
 "mode": "summary-only"
}

mode-summary-only terminal recording

Terminal cast

hide​

Hide both progress and the shutdown summary.

{
 "hide": true
}

hide terminal recording

Terminal cast

showSummaryWhenHidden​

Keep the process summary when live progress is hidden.

{
 "hide": true,
 "showSummaryWhenHidden": true,
 "detailedSuccess": true
}

showSummaryWhenHidden terminal recording

Terminal cast

throttleMs​

Limit live displays while still counting every observed file.

{
 "throttleMs": 1000,
 "detailedSuccess": true
}

throttleMs terminal recording

Terminal cast

minFilesBeforeShow​

Wait for three observed files before showing output.

{
 "minFilesBeforeShow": 3,
 "detailedSuccess": true
}

minFilesBeforeShow terminal recording

Terminal cast

outputStream​

Explicitly direct progress to stdout instead of the default stderr.

{
 "outputStream": "stdout"
}

outputStream terminal recording

Terminal cast

ttyOnly​

Suppress output when the selected stream is not a terminal.

{
 "ttyOnly": true
}

ttyOnly terminal recording

Terminal cast

non-tty​

Redirected output uses plain lines without spinner frames or color.

{}

non-tty terminal recording

Terminal cast

spinnerStyle-arc​

Use arc frames, advancing when files are observed.

{
 "spinnerStyle": "arc"
}

spinnerStyle-arc terminal recording

Terminal cast

spinnerStyle-bounce​

Use bounce frames, advancing when files are observed.

{
 "spinnerStyle": "bounce"
}

spinnerStyle-bounce terminal recording

Terminal cast

spinnerStyle-clock​

Use clock frames, advancing when files are observed.

{
 "spinnerStyle": "clock"
}

spinnerStyle-clock terminal recording

Terminal cast

spinnerStyle-dots​

Use dots frames, advancing when files are observed.

{
 "spinnerStyle": "dots"
}

spinnerStyle-dots terminal recording

Terminal cast

spinnerStyle-line​

Use line frames, advancing when files are observed.

{
 "spinnerStyle": "line"
}

spinnerStyle-line terminal recording

Terminal cast

Reproduce the recordings​

Install agg 1.9.0, then run npm run build and npm run docs:demos:write. The renderer uses the GitHub dark palette. Glyph appearance can vary with the system's monospace and fallback fonts.

npm run docs:demos:check regenerates the expected terminal traces in memory and checks every committed cast, GIF integrity hash, gallery entry, and static poster without writing files or requiring agg. Regenerate the recordings whenever output behavior changes.