Home Reference Source Test 
import Transformer from 'shinka-cli/src/Documenter/Transformer.js'
public class | source

Transformer

Transforms data into strings for documentation.

Example:

Transformer.example({
     command: 'release -f',
     description: 'Overwrites target file.'
});
// => $ release     # Overwrites target file.

Test:

Static Method Summary

Static Public Methods
public static

example(example: Example): string

public static

option(option: Option): string

Static Public Methods

public static example(example: Example): string source

Params:

NameTypeAttributeDescription
example Example

Return:

string

in format $ command # Description

Example:

Transformer.example({
     command: 'release -f',
     description: 'Overwrites target file.'
});
// => $ release -f     # Overwrites target file.

Test:

public static option(option: Option): string source

Params:

NameTypeAttributeDescription
option Option

Return:

string

in format flag: description

Example:

Transformer.option({
     flag: '-v, --verbose',
     description: 'Output verbose error messages.'
});
// => **-v, --verbose**: Output verbose error messages.

Test: