Daemon methods

The Biome daemon uses JSON-RPC, a lightweight RPC (remote procedure call) protocol that can be leveraged by third-party clients, such as editor extensions.

Clients send requests with the following JSON payload, where method is one of the methods listed on this page. Below is an example of a biome/open_project request:

1
{
2
  "jsonrpc": "2.0",
3
  "id": 1,
4
  "method": "biome/open_project",
5
  "params": {
6
    "path": "/Some/path",
7
    "openUninitialized": false
8
  }
9
}

Custom methods

`biome/file_features`

Accepts SupportsFeatureParams.

1
interface SupportsFeatureParams {
2
  features: FeatureName;
3
  inlineConfig?: Configuration;
4
  /**
5
   * Features that shouldn't be enabled
6
   */
7
  notRequestedFeatures?: FeatureName;
8
  path: string;
9
  projectKey: number;
10
  skipIgnoreCheck?: boolean;
11
}

Returns FileFeaturesResult.

1
interface FileFeaturesResult {
2
  featuresSupported: FeaturesSupported;
3
}

`biome/update_settings`

Accepts UpdateSettingsParams.

1
interface UpdateSettingsParams {
2
  configuration: Configuration;
3
  extendedConfigurations?: unknown[][];
4
  moduleGraphResolutionKind?: string;
5
  projectKey: number;
6
  workspaceDirectory?: string;
7
}

Returns UpdateSettingsResult.

1
interface UpdateSettingsResult {
2
  diagnostics: Diagnostic[];
3
}

`biome/open_project`

Accepts OpenProjectParams.

1
interface OpenProjectParams {
2
  /**
3
   * Whether the folder should be opened as a project, even if no `biome.json` can be found.
4
   */
5
  openUninitialized: boolean;
6
  /**
7
   * The path to open
8
   */
9
  path: string;
10
}

Returns OpenProjectResult.

1
interface OpenProjectResult {
2
  /**
3
   * A unique identifier for this project
4
   */
5
  projectKey: number;
6
}

`biome/scan_project`

Accepts ScanProjectParams.

1
interface ScanProjectParams {
2
  /**
3
   * Forces scanning of the folder, even if it is already being watched.
4
   */
5
  force: boolean;
6
  projectKey: number;
7
  scanKind: ScanKind;
8
  verbose?: boolean;
9
  /**
10
   * Whether the watcher should watch this path. Does nothing if the watcher is already watching this path.
11
   */
12
  watch: boolean;
13
}

Returns ScanProjectResult.

1
interface ScanProjectResult {
2
  /**
3
   * A list of child configuration files found inside the project
4
   */
5
  configurationFiles: string[];
6
  /**
7
   * Diagnostics reported while scanning the project.
8
   */
9
  diagnostics: Diagnostic[];
10
  /**
11
   * Duration of the scan.
12
   */
13
  duration: Duration;
14
}

`biome/open_file`

Accepts OpenFileParams.

1
interface OpenFileParams {
2
  content: FileContent;
3
  documentFileSource?: DocumentFileSource;
4
  inlineConfig?: Configuration;
5
  path: string;
6
  /**
7
   * Set to `true` to persist the node cache used during parsing, in order to speed up subsequent reparsing if the document has been edited. This should only be enabled if reparsing is to be expected, such as when the file is opened through the LSP Proxy.
8
   */
9
  persistNodeCache?: boolean;
10
  projectKey: number;
11
}

Returns OpenFileResult.

1
interface OpenFileResult {
2
  diagnostics: Diagnostic[];
3
}

`biome/change_file`

Accepts ChangeFileParams.

1
interface ChangeFileParams {
2
  content: string;
3
  inlineConfig?: Configuration;
4
  path: string;
5
  projectKey: number;
6
  version: number;
7
}

Returns ChangeFileResult.

1
interface ChangeFileResult {
2
  diagnostics: Diagnostic[];
3
}

`biome/close_file`

Accepts CloseFileParams.

1
interface CloseFileParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns void.

`biome/file_exists`

Accepts FileExitsParams.

1
interface FileExitsParams {
2
  filePath: string;
3
}

Returns boolean.

`biome/is_path_ignored`

Accepts PathIsIgnoredParams.

1
interface PathIsIgnoredParams {
2
  /**
3
   * Whether the path is ignored for specific features e.g. `formatter.includes`. When this field is empty, Biome checks only `files.includes`.
4
   */
5
  features: FeatureName;
6
  /**
7
   * Controls how to ignore check should be done
8
   */
9
  ignoreKind?: IgnoreKind;
10
  /**
11
   * Whether the path is a directory. Used to skip stat calls when the caller already knows the file type from the filesystem traversal.
12
   */
13
  isDir?: boolean;
14
  /**
15
   * The path to inspect
16
   */
17
  path: string;
18
  projectKey: number;
19
}

Returns boolean.

`biome/update_module_graph`

Accepts UpdateModuleGraphParams.

1
interface UpdateModuleGraphParams {
2
  path: string;
3
  projectKey: number;
4
  /**
5
   * The kind of update to apply to the module graph
6
   */
7
  updateKind: string;
8
}

Returns void.

`biome/get_syntax_tree`

Accepts GetSyntaxTreeParams.

1
interface GetSyntaxTreeParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns GetSyntaxTreeResult.

1
interface GetSyntaxTreeResult {
2
  ast: string;
3
  cst: string;
4
}

`biome/check_file_size`

Accepts CheckFileSizeParams.

1
interface CheckFileSizeParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns CheckFileSizeResult.

1
interface CheckFileSizeResult {
2
  fileSize: number;
3
  limit: number;
4
}

`biome/get_file_content`

Accepts GetFileContentParams.

1
interface GetFileContentParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns string.

`biome/get_control_flow_graph`

Accepts GetControlFlowGraphParams.

1
interface GetControlFlowGraphParams {
2
  cursor: number;
3
  path: string;
4
  projectKey: number;
5
}

Returns string.

`biome/get_formatter_ir`

Accepts GetFormatterIRParams.

1
interface GetFormatterIRParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns string.

`biome/get_type_info`

Accepts GetTypeInfoParams.

1
interface GetTypeInfoParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns string.

`biome/get_registered_types`

Accepts GetRegisteredTypesParams.

1
interface GetRegisteredTypesParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns string.

`biome/get_semantic_model`

Accepts GetSemanticModelParams.

1
interface GetSemanticModelParams {
2
  path: string;
3
  projectKey: number;
4
}

Returns string.

`biome/get_module_graph`

Accepts GetModuleGraphParams.

1
interface GetModuleGraphParams {}

Returns GetModuleGraphResult.

1
interface GetModuleGraphResult {
2
  data: object;
3
}

`biome/pull_diagnostics`

Accepts PullDiagnosticsParams.

1
interface PullDiagnosticsParams {
2
  categories: RuleCategories;
3
  /**
4
   * Minimum severity for a diagnostic to be included. Diagnostics with a severity below this threshold are ignored entirely (not counted, not serialized). Defaults to [`Severity::Hint`] (include everything).
5
   */
6
  diagnosticLevel?: Severity;
7
  /**
8
   * Rules to apply on top of the configuration
9
   */
10
  enabledRules?: string[];
11
  /**
12
   * When true, promote assist diagnostics (`assist/*`) to error severity before applying the diagnostic_level filter.
13
   */
14
  enforceAssist?: boolean;
15
  /**
16
   * When `true`, diagnostics include code suggestions for rule fixes.
17
   */
18
  includeCodeFix?: boolean;
19
  inlineConfig?: Configuration;
20
  /**
21
   * Max limit of diagnostics types to pull. This limit is meant to cap the number of [Diagnostic] to pull. However, the workspace still processes ALL diagnostics coming from the analyzer to compute their severity. If no value is provided, the workspace will pull all diagnostics.
22
   */
23
  maxDiagnostics?: unknown;
24
  only?: string[];
25
  path: string;
26
  projectKey: number;
27
  skip?: string[];
28
}

Returns PullDiagnosticsResult.

1
interface PullDiagnosticsResult {
2
  diagnostics: Diagnostic[];
3
  errors: number;
4
  infos: number;
5
  /**
6
   * Number of parse errors (subset of `errors`). Used by `--skip-parse-errors` to distinguish parse errors from analyzer errors.
7
   */
8
  parseErrors: number;
9
  skippedDiagnostics: number;
10
  warnings: number;
11
}

`biome/pull_actions`

Accepts PullActionsParams.

1
interface PullActionsParams {
2
  categories?: RuleCategories;
3
  /**
4
   * When `false`, returned actions have `suggestion: None` (no `BatchMutation` computed). Used by `codeAction/resolve` to defer edit computation.
5
   */
6
  computeActions?: boolean;
7
  enabledRules?: string[];
8
  inlineConfig?: Configuration;
9
  only?: string[];
10
  path: string;
11
  projectKey: number;
12
  range?: TextRange;
13
  skip?: string[];
14
  suppressionReason?: unknown;
15
}

Returns PullActionsResult.

1
interface PullActionsResult {
2
  actions: CodeAction[];
3
}

`biome/pull_diagnostics_and_actions`

Accepts PullDiagnosticsAndActionsParams.

1
interface PullDiagnosticsAndActionsParams {
2
  categories?: RuleCategories;
3
  enabledRules?: string[];
4
  inlineConfig?: Configuration;
5
  only?: string[];
6
  path: string;
7
  projectKey: number;
8
  skip?: string[];
9
}

Returns PullDiagnosticsAndActionsResult.

1
interface PullDiagnosticsAndActionsResult {
2
  diagnostics: unknown[][];
3
}

`biome/format_file`

Accepts FormatFileParams.

1
interface FormatFileParams {
2
  inlineConfig?: Configuration;
3
  path: string;
4
  projectKey: number;
5
}

Returns Printed.

1
interface Printed {
2
  code: string;
3
  range?: TextRange;
4
  sourcemap: SourceMarker[];
5
  verbatimRanges: TextRange[];
6
}

`biome/format_range`

Accepts FormatRangeParams.

1
interface FormatRangeParams {
2
  inlineConfig?: Configuration;
3
  path: string;
4
  projectKey: number;
5
  range: TextRange;
6
}

Returns Printed.

1
interface Printed {
2
  code: string;
3
  range?: TextRange;
4
  sourcemap: SourceMarker[];
5
  verbatimRanges: TextRange[];
6
}

`biome/format_on_type`

Accepts FormatOnTypeParams.

1
interface FormatOnTypeParams {
2
  inlineConfig?: Configuration;
3
  offset: number;
4
  path: string;
5
  projectKey: number;
6
}

Returns Printed.

1
interface Printed {
2
  code: string;
3
  range?: TextRange;
4
  sourcemap: SourceMarker[];
5
  verbatimRanges: TextRange[];
6
}

`biome/fix_file`

Accepts FixFileParams.

1
interface FixFileParams {
2
  /**
3
   * Rules to apply to the file
4
   */
5
  enabledRules?: string[];
6
  fixFileMode: FixFileMode;
7
  inlineConfig?: Configuration;
8
  only?: string[];
9
  path: string;
10
  projectKey: number;
11
  ruleCategories: RuleCategories;
12
  shouldFormat: boolean;
13
  skip?: string[];
14
  suppressionReason?: unknown;
15
}

Returns FixFileResult.

1
interface FixFileResult {
2
  /**
3
   * List of all the code actions applied to the file
4
   */
5
  actions: FixAction[];
6
  /**
7
   * New source code for the file with all fixes applied
8
   */
9
  code: string;
10
  /**
11
   * Number of errors
12
   */
13
  errors: number;
14
  /**
15
   * number of skipped suggested fixes
16
   */
17
  skippedSuggestedFixes: number;
18
}

`biome/rename`

Accepts RenameParams.

1
interface RenameParams {
2
  newName: string;
3
  path: string;
4
  projectKey: number;
5
  symbolAt: number;
6
}

Returns RenameResult.

1
interface RenameResult {
2
  /**
3
   * List of text edit operations to apply on the source code
4
   */
5
  indels: TextEdit;
6
  /**
7
   * Range of source code modified by this rename operation
8
   */
9
  range: TextRange;
10
}

`biome/parse_pattern`

Accepts ParsePatternParams.

1
interface ParsePatternParams {
2
  defaultLanguage: GritTargetLanguage;
3
  pattern: string;
4
}

Returns ParsePatternResult.

1
interface ParsePatternResult {
2
  patternId: string;
3
}

`biome/search_pattern`

Accepts SearchPatternParams.

1
interface SearchPatternParams {
2
  path: string;
3
  pattern: string;
4
  projectKey: number;
5
}

Returns SearchResults.

1
interface SearchResults {
2
  matches: TextRange[];
3
  path: string;
4
}

`biome/drop_pattern`

Accepts DropPatternParams.

1
interface DropPatternParams {
2
  pattern: string;
3
}

Returns void.