Interface PrettyPrinterService

Service providing syntax based pretty printing of text for the CLI using prettier.

interface PrettyPrinterService {
    getRegisteredSyntaxes(): Promise<readonly string[]>;
    prettify(text: string, syntaxName: string): Promise<string>;
    registerSyntax(
        syntaxName: string,
        syntaxDefinition: Plugin<unknown>,
    ): Promise<void>;
}

Index

Methods

getRegisteredSyntaxes prettify registerSyntax

Methods

getRegisteredSyntaxes

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

Returns Promise<readonly string[]>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/PrettyPrinterService.ts:30

prettify

prettify(text: string, syntaxName: string): Promise<string>
Return a pretty printed version of the provided text using the specified syntax.
Parameters
- text: string
  the text to prettify.
- syntaxName: string
  the syntax to use.
Returns Promise<string>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/PrettyPrinterService.ts:38

registerSyntax

registerSyntax(
syntaxName: string,
syntaxDefinition: Plugin<unknown>,
): Promise<void>
Register a new syntax.

The recommended way to define a new language syntax plugin is to follow the instructions here:

https://prettier.io/docs/plugins#developing-plugins

There is a list of already defined languages available for import here:
- https://prettier.io/docs/
- https://prettier.io/docs/plugins
Parameters
- syntaxName: string
  the name used to refer to the syntax.
- syntaxDefinition: Plugin<unknown>
  the definition for the syntax conforming to the Prettier plugin interface.
Returns Promise<void>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/PrettyPrinterService.ts:25

Interface PrettyPrinterService

Index

Methods

Methods

getRegisteredSyntaxes

Returns Promise<readonly string[]>

prettify

Parameters

Returns Promise<string>

registerSyntax

Parameters

Returns Promise<void>

Settings

On This Page