Class Unibeautify

Beautifier

Hierarchy

Unibeautify

Index

Properties

Accessors

Properties

Private beautifiers

beautifiers: Beautifier[] = []

Private languageManager

languageManager: LanguageManager = new LanguageManager(this.languages)

Private languages

languages: Language[] = []

Private options

options: OptionsRegistry

Private optionsManager

optionsManager: OptionsManager = new OptionsManager(this.options)

Accessors

loadedBeautifiers

get loadedBeautifiers(): Beautifier[]

- Defined in src/beautifier.ts:539
Get a shallow copy of the beautifiers currently loaded.

Returns Beautifier[]

loadedOptions

get loadedOptions(): OptionsRegistry

- Defined in src/beautifier.ts:532
Get a shallow copy of the options currently loaded.

Returns OptionsRegistry

supportedLanguages

get supportedLanguages(): Language[]

- Defined in src/beautifier.ts:279
Get all loaded languages which have at least one supporting beautifier.

Returns Language[]

Methods

Private beautifiersForLanguageAndOptions

beautifiersForLanguageAndOptions(lang: Language, langOptions: OptionValues): { missingBeautifierName: string | undefined; selectedBeautifiers: (undefined | Beautifier)[] }

- Defined in src/beautifier.ts:324
Parameters
- lang: Language
- langOptions: OptionValues
Returns { missingBeautifierName: string | undefined; selectedBeautifiers: (undefined | Beautifier)[] }
- missingBeautifierName: string | undefined
- selectedBeautifiers: (undefined | Beautifier)[]

Private beautifiersWithNames

beautifiersWithNames(names: string[], beautifiers: Beautifier[]): (undefined | Beautifier)[]

- Defined in src/beautifier.ts:349
Parameters
- names: string[]
- beautifiers: Beautifier[]
Returns (undefined | Beautifier)[]

beautify

beautify(data: BeautifyData): Promise<string>

- Defined in src/beautifier.ts:288
Beautify code

Parameters
- data: BeautifyData
Returns Promise<string>

Private beautifyWithBeautifiers

beautifyWithBeautifiers(__namedParameters: { beautifiers: Beautifier[]; fileExtension: undefined | string; filePath: undefined | string; langOptions: OptionValues; language: Language; projectPath: undefined | string; text: string }): Promise<string>

- Defined in src/beautifier.ts:361
Parameters
- __namedParameters: { beautifiers: Beautifier[]; fileExtension: undefined | string; filePath: undefined | string; langOptions: OptionValues; language: Language; projectPath: undefined | string; text: string }
  - beautifiers: Beautifier[]
  - fileExtension: undefined | string
  - filePath: undefined | string
  - langOptions: OptionValues
  - language: Language
  - projectPath: undefined | string
  - text: string
Returns Promise<string>

Private doesBeautifierSupportLanguage

doesBeautifierSupportLanguage(beautifier: Beautifier, language: Language): boolean

- Defined in src/beautifier.ts:479
Parameters
- beautifier: Beautifier
- language: Language
Returns boolean

doesBeautifierSupportOptionForLanguage

doesBeautifierSupportOptionForLanguage(__namedParameters: { beautifier: Beautifier; language: Language; optionName: string }): boolean

- Defined in src/beautifier.ts:507
Determine whether beautifier supports option for a language

Parameters
- __namedParameters: { beautifier: Beautifier; language: Language; optionName: string }
  - beautifier: Beautifier
  - language: Language
  - optionName: string
Returns boolean

findLanguages

findLanguages(query: LanguageQuery): Language[]

- Defined in src/beautifier.ts:450
deprecated

use LanguageManager

Parameters
- query: LanguageQuery
Returns Language[]

Private getBeautifierForLanguage

getBeautifierForLanguage(language: Language): Beautifier | undefined

- Defined in src/beautifier.ts:464
Get first loaded beautifier for given language.

Parameters
- language: Language
Returns Beautifier | undefined

getBeautifiersForLanguage

getBeautifiersForLanguage(language: Language): Beautifier[]

- Defined in src/beautifier.ts:473
Find and return the appropriate Beautifiers for the given Language.

Parameters
- language: Language
Returns Beautifier[]

getBeautifiersSupportingOption

getBeautifiersSupportingOption(optionName: BeautifierOptionName): Beautifier[]

- Defined in src/beautifier.ts:489
Get loaded beautifiers which have a loaded languages supporting the given option

Parameters
- optionName: BeautifierOptionName
Returns Beautifier[]

getLanguagesForBeautifier

getLanguagesForBeautifier(beautifier: Beautifier): Language[]

- Defined in src/beautifier.ts:522
Find loaded languages the given beautifier supports.

Parameters
- beautifier: Beautifier
Returns Language[]

getLanguagesSupportingOption

getLanguagesSupportingOption(optionName: BeautifierOptionName): Language[]

- Defined in src/beautifier.ts:221
Get loaded languages which have a loaded beautifier supporting the given option

Parameters
- optionName: BeautifierOptionName
Returns Language[]

getLoadedLanguages

getLoadedLanguages(): Language[]

- Defined in src/beautifier.ts:457
deprecated

use LanguageManager

Returns Language[]

getOptionsSupportedByBeautifierForLanguage

getOptionsSupportedByBeautifierForLanguage(__namedParameters: { beautifier: Beautifier; language: Language }): OptionsRegistry

- Defined in src/beautifier.ts:255
Get options supported by beautifier for a language.

Parameters
- __namedParameters: { beautifier: Beautifier; language: Language }
  - beautifier: Beautifier
  - language: Language
Returns OptionsRegistry

getOptionsSupportedForLanguage

getOptionsSupportedForLanguage(language: Language): OptionsRegistry

- Defined in src/beautifier.ts:239
Get options supported for language and all loaded beautifiers

Parameters
- language: Language
Returns OptionsRegistry

Private handleInlineFlags

handleInlineFlags(currentText: string, newText: string): string

- Defined in src/beautifier.ts:442
Parameters
- currentText: string
- newText: string
Returns string

loadBeautifier

loadBeautifier(beautifier: Beautifier): Unibeautify

- Defined in src/beautifier.ts:610
Load a Beautifier

Parameters
- beautifier: Beautifier
Returns Unibeautify

loadBeautifiers

loadBeautifiers(beautifiers: Beautifier[]): Unibeautify

- Defined in src/beautifier.ts:627
Load multiple beautifiers.

Parameters
- beautifiers: Beautifier[]
Returns Unibeautify

loadLanguage

loadLanguage(language: Language): Unibeautify

- Defined in src/beautifier.ts:635
Load a single language

Parameters
- language: Language
Returns Unibeautify

loadLanguages

loadLanguages(languages: Language[]): Unibeautify

- Defined in src/beautifier.ts:643
Load multiple languages

Parameters
- languages: Language[]
Returns Unibeautify

loadOptions

loadOptions(options: OptionsRegistry): Unibeautify

- Defined in src/beautifier.ts:651
Load multiple options

Parameters
- options: OptionsRegistry
Returns Unibeautify

Private validateBeautifier

validateBeautifier(beautifier?: any): void

- Defined in src/beautifier.ts:616
Parameters
- Default value beautifier: any = {}
Returns void

Static getOptionsForBeautifier

getOptionsForBeautifier(beautifier: Beautifier, language: Language, options: OptionValues): OptionValues

- Defined in src/beautifier.ts:557
Extract the option values that the Beautifier supports, including applying transformations.

Parameters
- beautifier: Beautifier
- language: Language
- options: OptionValues
Returns OptionValues

Static getOptionsForLanguage

getOptionsForLanguage(language: Language, options: LanguageOptionValues): OptionValues

- Defined in src/beautifier.ts:546
Extract the Language-specific option values.

Parameters
- language: Language
- options: LanguageOptionValues
Returns OptionValues

Generated using TypeDoc