Class Formatter

Formatter class for creating styled terminal output with Codeforces theme. Uses chalk library for coloring with custom hex colors (#1E88E5 blue, #FF6B6B red).

Formatter

Example

import { fmt } from './formatter';

fmt.section('📁 CREATE TEMPLATE');
fmt.step(1, 'Creating directory');
fmt.success('Directory created!');
fmt.stepComplete('Done');

Index

Constructors

constructor

Properties

target errorSink

Constructors

constructor

new Formatter(): Formatter
Returns Formatter

Properties

`Private`target

target: OutputTarget = 'stdout'

`Private`errorSink

errorSink: ErrorSink | null = null

Methods

setOutput

setOutput(target: OutputTarget): void
Routes all printed output to stdout (default) or stderr. --json commands switch to stderr so stdout carries only the JSON report.
Parameters
- target: OutputTarget
  Stream to print to
Returns void
- Defined in formatter.ts:43

getOutput

getOutput(): OutputTarget
Returns the stream human output currently goes to.

Returns OutputTarget
'stdout' or 'stderr'
- Defined in formatter.ts:51

setErrorSink

setErrorSink(sink: ErrorSink | null): void
Registers a listener that receives every error() message, or null to remove it. Used by the JSON report collector to capture failure text.
Parameters
- sink: ErrorSink | null
  Listener for error messages
Returns void
- Defined in formatter.ts:60

`Private`print

print(...parts: string[]): void
Parameters
- ...parts: string[]
Returns void
- Defined in formatter.ts:64

success

success(message: string): void
Prints a success message in green.
Parameters
- message: string
  The message to display
Returns void
Example
```
fmt.success('Template created successfully!');
```
- Defined in formatter.ts:78

error

error(message: string): void
Prints an error message in red.
Parameters
- message: string
  The error message to display
Returns void
Example
```
fmt.error('Failed to compile validator');
```
- Defined in formatter.ts:88

warning

warning(message: string): void
Prints a warning message in yellow.
Parameters
- message: string
  The warning message to display
Returns void
Example
```
fmt.warning('testlib.h already exists');
```
- Defined in formatter.ts:99

info

info(message: string): void
Prints an informational message in white.
Parameters
- message: string
  The info message to display
Returns void
Example
```
fmt.info(`Target: ${generatorName}`);
```
- Defined in formatter.ts:109

log

log(message: string): void
Prints a dimmed/gray log message. Used for less important information.
Parameters
- message: string
  The message to display
Returns void
Example
```
fmt.log('Additional details...');
```
- Defined in formatter.ts:120

checkmark

checkmark(): string
Returns a green checkmark icon (✓). Use explicitly in messages for better indentation control.

Returns string
Styled checkmark
Example
```
fmt.success(`${fmt.checkmark()} Test passed`);
```
- Defined in formatter.ts:131

cross

cross(): string
Returns a red cross icon (✖). Use explicitly in messages for better indentation control.

Returns string
Styled cross
Example
```
fmt.error(`${fmt.cross()} Test failed`);
```
- Defined in formatter.ts:142

warningIcon

warningIcon(): string
Returns a yellow warning icon (⚠). Use explicitly in messages for better indentation control.

Returns string
Styled warning icon
Example
```
fmt.warning(`${fmt.warningIcon()} Memory limit not supported on Windows`);
```
- Defined in formatter.ts:153

infoIcon

infoIcon(): string
Returns a blue info icon (ℹ). Use explicitly in messages for better indentation control.

Returns string
Styled info icon
Example
```
fmt.info(`${fmt.infoIcon()} Found 5 generators`);
```
- Defined in formatter.ts:164

section

section(title: string): void
Prints a section header with blue double-line border. Used to separate major sections in command output.
Parameters
- title: string
  The section title
Returns void
Example
```
fmt.section('📁 CREATE NEW PROBLEM TEMPLATE');
```
- Defined in formatter.ts:175

step

step(stepNumber: number, title: string): void
Prints a numbered step header with a top corner bracket.
Parameters
- stepNumber: number
  The step number
- title: string
  The step description
Returns void
Example
```
fmt.step(1, 'Creating Directory Structure');
```
- Defined in formatter.ts:190

newLine

newLine(): void
Prints a newLine.

Returns void
Example
```
fmt.newLine();
```
- Defined in formatter.ts:201

stepComplete

stepComplete(message?: string): void
Prints a step completion message with a bottom corner bracket and checkmark.
Parameters
- Optionalmessage: string
  Optional completion message (defaults to 'Complete')
Returns void
Example
```
fmt.stepComplete('Directory created');
```
- Defined in formatter.ts:211

highlight

highlight(text: string): string
Returns highlighted text in Codeforces blue color.
Parameters
- text: string
  Text to highlight
Returns string
Styled text
Example
```
fmt.info(`Target: ${fmt.highlight('all')}`);
```
- Defined in formatter.ts:226

dim

dim(text: string): string
Returns dimmed/grayed text.
Parameters
- text: string
  Text to dim
Returns string
Styled text
Example
```
fmt.info(`${fmt.dim('(optional)')}`);
```
- Defined in formatter.ts:237

bold

bold(text: string): string
Returns bold text.
Parameters
- text: string
  Text to make bold
Returns string
Styled text
Example
```
this.print(fmt.bold('Important:'));
```
- Defined in formatter.ts:248

accent

accent(text: string): string
Returns text in Codeforces red accent color (#FF6B6B).
Parameters
- text: string
  Text to style
Returns string
Styled text
Example
```
fmt.log(`Error: ${fmt.accent('Failed')}`);
```
- Defined in formatter.ts:259

primary

primary(text: string): string
Returns text in Codeforces primary blue color (#1E88E5).
Parameters
- text: string
  Text to style
Returns string
Styled text
Example
```
fmt.info(`Main solution: ${fmt.primary(mainSolution.name)}`);
```
- Defined in formatter.ts:270

successBox

successBox(message: string): void
Prints a success box with green border and celebration emoji. Used for final success messages.
Parameters
- message: string
  Success message to display
Returns void
Example
```
fmt.successBox('TEMPLATE CREATED SUCCESSFULLY!');
```
- Defined in formatter.ts:281

errorBox

errorBox(message: string): void
Prints an error box with red border and cross emoji. Used for final error messages.
Parameters
- message: string
  Error message to display
Returns void
Example
```
fmt.errorBox('VALIDATION FAILED!');
```
- Defined in formatter.ts:300

Class Formatter

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Formatter

Properties

Privatetarget

PrivateerrorSink

Methods

setOutput

Parameters

Returns void

getOutput

Returns OutputTarget

setErrorSink

Parameters

Returns void

Privateprint

Parameters

Returns void

success

Parameters

Returns void

Example

error

Parameters

Returns void

Example

warning

Parameters

Returns void

Example

info

Parameters

Returns void

Example

log

Parameters

Returns void

Example

checkmark

Returns string

Example

cross

Returns string

Example

warningIcon

Returns string

Example

infoIcon

Returns string

Example

section

Parameters

Returns void

Example

step

Parameters

Returns void

Example

newLine

Returns void

Example

stepComplete

Parameters

Returns void

Example

highlight

Parameters

Returns string

Example

dim

Parameters

Returns string

Example

bold

`Private`target

`Private`errorSink

`Private`print