Choose your progress preset

Every preset is a native unified preset. Export it from your remark config or combine it with existing presets in the plugins array.

Choose by workflow

Preset	Best for	Behavior
🟢 recommended	Follow each Markdown file	Show each file using the default display options.
🔵 recommended-ci	Keep CI logs quiet	Hide all plugin output when CI is exactly true.
🟣 recommended-ci-detailed	Keep a summary in CI	Hide live output in CI while retaining the detailed process summary.
🟡 recommended-compact	Show activity without paths	Show generic activity without filenames; redirected output announces it once.
🟠 recommended-detailed	See process-wide metrics	Show filenames and the detailed process summary.
🩷 recommended-summary-only	Read the final summary	Show only the final process summary.
🟦 recommended-tty	Respect redirected output	Show output only when stderr is an interactive terminal.

Use a preset

import recommended from "remark-lint-file-progress/configs/recommended";

export default recommended;

Compose existing presets with plugins: [existingPreset, recommended]. Each progress preset registers the same callable plugin and adds no lint diagnostics.

Customize or disable

Add [progress, options] to your plugins array after the preset to customize the display, or [progress, false] to disable it. Unified merges repeated registrations. See getting started and all options.

CI and terminal behavior

The two CI presets activate their CI behavior only when CI is exactly true. Outside CI, both display ordinary progress. The TTY preset checks stderr, the default output stream. Summary counts and timing cover the process lifetime; read compatibility and metrics before interpreting them.

Watch all preset recordings, explore option demonstrations, or use troubleshooting if your output differs.