Interface: FormatCapability

Defined in: src/batteries/dev_tools/types.ts:88

A formatter capability declaration.

Properties

Property	Type	Description	Defined in
extensions	readonly string[]	Extensions participating in this selection pass.	src/batteries/dev_tools/types.ts:90
generates?	boolean	Allows output when the invocation has no input paths.	src/batteries/dev_tools/types.ts:98
inPlace?	boolean	Selects disk-mutating execution through the restricted access façade.	src/batteries/dev_tools/types.ts:92
needs?	readonly ("delete" | "rename" | "mkdir")[]	Filesystem operations granted to an in-place capability; duplicates are ignored.	src/batteries/dev_tools/types.ts:96
scope?	readonly string[]	Glob permission used for selection and in-place authorization.	src/batteries/dev_tools/types.ts:94

Methods

format()

format(request: FormatRequest): Promise<WorkspaceDelta>;

Defined in: src/batteries/dev_tools/types.ts:100

Formats the supplied paths and returns a workspace delta; it must not mutate the map directly.

Parameters

Parameter	Type
request	FormatRequest

Returns

Promise<WorkspaceDelta>