@refactor-ai/ts-format

Format a file with the TypeScript formatter.

Use Node.js 22+ and npm. Bun and a source checkout are unnecessary. This package supports TypeScript and JavaScript and includes only their compiler adapter. npm installs its pinned TypeScript dependency. This package has no install lifecycle scripts.

npx @refactor-ai/ts-format --help
npx @refactor-ai/ts-format plan --help
npx @refactor-ai/ts-format plan --project examples/typescript/tsconfig.json --file examples/typescript/math.ts

Replace example paths with your project paths. Planning leaves sources untouched and returns a saved plan path. Preview and validate it, then apply that exact plan:

npx @refactor-ai/ts-format preview --plan ./path/to/plan.json
npx @refactor-ai/ts-format validate --plan ./path/to/plan.json
npx @refactor-ai/ts-format apply --plan ./path/to/plan.json

Or install with npm install --save-dev @refactor-ai/ts-format and run npx refactor-ts-format --help. Only format can be planned by this tool. Plans use snapshots, compiler diagnostics and journaled writes. Validation does not run project tests. Full options, language support, limitations and examples are available in --help.

Built from refactor-ai 0.1.4. Third-party diff license: licenses/diff.txt.

Programmatic use

Importing the package does not execute the CLI, load a project or build the C# helper. createRefactor() returns an object with plan(options), preview(plan), validate(plan), apply(plan), loadPlan(path) and capabilities(project). Methods return objects and reject with Errors rather than printing CLI output. TypeScript declarations are included.

import { createRefactor } from "@refactor-ai/ts-format";
const refactor = await createRefactor();
const supported = await refactor.capabilities("./tsconfig.json");

This API plans only format; omit operation in plan options. Read API.md for the complete interface, source-change workflow, coordinate conventions, language requirements and automation examples.