Skip to content
2 min read · 384 words

Interface: DevChain

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

Chainable development plan builder.

Extends

Methods

applyPatch()

ts
applyPatch(args: {
  patch: string;
}): DevChain;

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

Append a structured patch step.

Parameters

ParameterType
args{ patch: string; }
args.patchstring

Returns

DevChain


check()

ts
check(): DevChain;

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

Append a whole-workspace checker step.

Returns

DevChain


edit()

ts
edit(args: {
  edits: readonly {
     find: string;
     replace: string;
  }[];
  path: string;
}): DevChain;

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

Append deterministic find-and-replace edits to the plan.

Parameters

ParameterType
args{ edits: readonly { find: string; replace: string; }[]; path: string; }
args.editsreadonly { find: string; replace: string; }[]
args.pathstring

Returns

DevChain


format()

ts
format(args?: {
  paths?: readonly string[];
}): DevChain;

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

Append a formatter step.

Parameters

ParameterType
args?{ paths?: readonly string[]; }
args.paths?readonly string[]

Returns

DevChain


lint()

ts
lint(args?: {
  fix?: boolean;
  paths?: readonly string[];
}): DevChain;

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

Append a linter step, optionally granting fix permission.

Parameters

ParameterType
args?{ fix?: boolean; paths?: readonly string[]; }
args.fix?boolean
args.paths?readonly string[]

Returns

DevChain


readLines()

ts
readLines(args: {
  end?: number;
  label?: string;
  path: string;
  start: number;
}): DevChain;

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

Append a line-reading step; label is lifted to the operation metadata.

Parameters

ParameterType
args{ end?: number; label?: string; path: string; start: number; }
args.end?number
args.label?string
args.pathstring
args.startnumber

Returns

DevChain


run()

ts
run(options?: RunOptions): Promise<DevResult>;

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

Execute this immutable chain, overriding its open-time options when supplied.

Parameters

ParameterType
options?RunOptions

Returns

Promise<DevResult>


toOps()

ts
toOps(): DevOp[];

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

Return the serializable operations currently held by this chain.

Returns

DevOp[]


write()

ts
write(args?: {
  paths?: readonly string[];
}): DevChain;

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

Append the persistence step, optionally restricted to normalized paths.

Parameters

ParameterType
args?{ paths?: readonly string[]; }
args.paths?readonly string[]

Returns

DevChain