Interface FormatterService

ReadonlyonDidChangeFormatters

getAvailableFormatters

• getAvailableFormatters(editor: TextEditor): FormatterInfo[]

  Get all available formatters for the given editor's language

  Parameters

  • editor: TextEditor

  Returns FormatterInfo[]

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

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

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

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>