Interface SyntaxHighlighterService

Service providing syntax based color highlighting of text for the CLI using highlight.js.

interface SyntaxHighlighterService {
    getRegisteredSyntaxes(): readonly string[];
    highlight(
        text: string,
        syntaxName: string,
        colorScheme?: ColorScheme,
    ): string;
    registerSyntax(syntaxName: string, syntaxDefinition: LanguageFn): void;
}

Index

Methods

getRegisteredSyntaxes highlight registerSyntax

Methods

getRegisteredSyntaxes

getRegisteredSyntaxes(): readonly string[]
Return the names of the currently registered syntaxes.

Returns readonly string[]
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SyntaxHighlighterService.ts:43

highlight

highlight(text: string, syntaxName: string, colorScheme?: ColorScheme): string
Return a syntactically highlighted version of the provided text using the specified syntax. The returned text will include appropriate color styling. An optional ColorScheme can be provided.
Parameters
- text: string
  the text to highlight.
- syntaxName: string
  the syntax to use.
- OptionalcolorScheme: ColorScheme
  the color scheme to use.
Returns string
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SyntaxHighlighterService.ts:53

registerSyntax

registerSyntax(syntaxName: string, syntaxDefinition: LanguageFn): void
Register a new syntax.

The recommended way to define a new language syntax is to follow the instructions here:
There is a list of already defined languages available for import here:

https://github.com/highlightjs/highlight.js/blob/main/SUPPORTED_LANGUAGES.md
Parameters
- syntaxName: string
  the name used to refer to the syntax.
- syntaxDefinition: LanguageFn
  the definition for the syntax conforming to the Highlight JS language definition syntax.
Returns void
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/SyntaxHighlighterService.ts:38

Interface SyntaxHighlighterService

Index

Methods

Methods

getRegisteredSyntaxes

Returns readonly string[]

highlight

Parameters

Returns string

registerSyntax

Parameters

Returns void

Settings

On This Page