Class MonacoFormatterService

Implements

FormatterService

Index

Constructors

Properties

onDidChangeFormatters onDidChangeFormattersEmitter preferenceSchema preferenceService workspaceService

Methods

extractUniqueFormatters getAvailableFormatters getConfiguredFormatterStatus getConfiguredScope getConfiguredScopeFromInspection getDefaultFormatter getEditorModel getFormatterPreferenceName getFormatterStatus init preferenceToFormatterScope setDefaultFormatter

Constructors

constructor

new MonacoFormatterService(): MonacoFormatterService
Returns MonacoFormatterService

Properties

`Readonly`onDidChangeFormatters

onDidChangeFormatters: Event<void> = ...

Event fired when formatters change (e.g., new formatter registered/unregistered)

`Protected` `Readonly`onDidChangeFormattersEmitter

onDidChangeFormattersEmitter: Emitter<void> = ...

`Protected` `Readonly`preferenceSchema

preferenceSchema: PreferenceLanguageOverrideService

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`workspaceService

workspaceService: WorkspaceService

Methods

`Protected`extractUniqueFormatters

extractUniqueFormatters(
    formatters: (
        DocumentFormattingEditProvider
        | DocumentRangeFormattingEditProvider
    )[],
): FormatterInfo[]
Parameters
- formatters: (DocumentFormattingEditProvider | DocumentRangeFormattingEditProvider)[]
Returns FormatterInfo[]
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:197

getAvailableFormatters

getAvailableFormatters(editor: TextEditor): FormatterInfo[]
Get all available formatters for the given editor's language
Parameters
- editor: TextEditor
Returns FormatterInfo[]
Implementation of FormatterService.getAvailableFormatters
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:175

`Protected`getConfiguredFormatterStatus

getConfiguredFormatterStatus(
    preferenceName: string,
    resourceUri: string,
    formatters: FormatterInfo[],
): undefined | FormatterStatus
Parameters
- preferenceName: string
- resourceUri: string
- formatters: FormatterInfo[]
Returns undefined | FormatterStatus
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:117

getConfiguredScope

getConfiguredScope(editor: TextEditor): undefined | PreferenceScope
Get the scope at which the formatter is currently configured for the given editor. Returns undefined if no formatter is configured.
Parameters
- editor: TextEditor
  The text editor
Returns undefined | PreferenceScope
The preference scope where the formatter is set, or undefined
Implementation of FormatterService.getConfiguredScope
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:230

`Protected`getConfiguredScopeFromInspection

getConfiguredScopeFromInspection<T>(
inspection: PreferenceInspection<T>,
): undefined | PreferenceScope
Determines the preference scope from an inspection result. In single-folder workspaces, folder and workspace scopes are equivalent, so we need to check if we're in a multi-root workspace.
Type Parameters
- T
Parameters
- inspection: PreferenceInspection<T>
Returns undefined | PreferenceScope
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:149

getDefaultFormatter

getDefaultFormatter(languageId: string, resourceUri: string): undefined | string
Get the default formatter ID for the given language and resource URI. This is used internally during formatting operations.
Parameters
- languageId: string
  The language identifier
- resourceUri: string
  The resource URI
Returns undefined | string
The formatter ID or undefined if not set
Implementation of FormatterService.getDefaultFormatter
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:225

`Protected`getEditorModel

getEditorModel(editor: TextEditor): undefined | ITextModel
Parameters
- editor: TextEditor
Returns undefined | ITextModel
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:188

`Protected`getFormatterPreferenceName

getFormatterPreferenceName(languageId: string): string
Parameters
- languageId: string
Returns string
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:83

getFormatterStatus

getFormatterStatus(editor: TextEditor): FormatterStatus
Get the complete formatter status including the formatter info, scope, and validation state. This is the preferred method to get formatter information as it provides all necessary context.
Parameters
- editor: TextEditor
Returns FormatterStatus
Implementation of FormatterService.getFormatterStatus
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:90

`Protected`init

init(): void
Returns void
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:65

`Protected`preferenceToFormatterScope

preferenceToFormatterScope(
scope: undefined | PreferenceScope,
): FormatterSettingScope
Parameters
- scope: undefined | PreferenceScope
Returns FormatterSettingScope
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:162

setDefaultFormatter

setDefaultFormatter(
    languageIdOrEditor: string | TextEditor,
    formatterId: undefined | string,
    scope: PreferenceScope,
): Promise<void>
Set the default formatter for the given language or editor's language
Parameters
- languageIdOrEditor: string | TextEditor
  The language ID or editor to set the formatter for
- formatterId: undefined | string
  The formatter ID, or undefined to clear the setting
- scope: PreferenceScope
  The preference scope to save to
Returns Promise<void>
Implementation of FormatterService.setDefaultFormatter
- Defined in packages/monaco/src/browser/monaco-formatter-service.ts:217

Class MonacoFormatterService

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns MonacoFormatterService

Properties

ReadonlyonDidChangeFormatters

Protected ReadonlyonDidChangeFormattersEmitter

Protected ReadonlypreferenceSchema

Protected ReadonlypreferenceService

Protected ReadonlyworkspaceService

Methods

ProtectedextractUniqueFormatters

Parameters

Returns FormatterInfo[]

getAvailableFormatters

Parameters

Returns FormatterInfo[]

ProtectedgetConfiguredFormatterStatus

Parameters

Returns undefined | FormatterStatus

getConfiguredScope

Parameters

Returns undefined | PreferenceScope

ProtectedgetConfiguredScopeFromInspection

Type Parameters

Parameters

Returns undefined | PreferenceScope

getDefaultFormatter

Parameters

Returns undefined | string

ProtectedgetEditorModel

Parameters

Returns undefined | ITextModel

ProtectedgetFormatterPreferenceName

Parameters

Returns string

getFormatterStatus

Parameters

Returns FormatterStatus

Protectedinit

Returns void

ProtectedpreferenceToFormatterScope

Parameters

Returns FormatterSettingScope

setDefaultFormatter

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`onDidChangeFormatters

`Protected` `Readonly`onDidChangeFormattersEmitter

`Protected` `Readonly`preferenceSchema

`Protected` `Readonly`preferenceService

`Protected` `Readonly`workspaceService

`Protected`extractUniqueFormatters

`Protected`getConfiguredFormatterStatus

`Protected`getConfiguredScopeFromInspection

`Protected`getEditorModel

`Protected`getFormatterPreferenceName

`Protected`init

`Protected`preferenceToFormatterScope