dart-format
Format Dart code files to maintain consistent style and readability across projects. Apply standardized formatting rules to improve code quality and team collaboration.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paths | Yes | Files or directories to format | |
| setExitIfChanged | No | Return exit code 1 if there are any formatting changes | |
| options | No | Additional format options |
Implementation Reference
- src/tools/format.ts:11-31 (handler)The main handler function 'format' that implements the 'dart-format' tool by executing the 'dart format' CLI command with the provided paths, options, and flags.export async function format(args: z.infer<typeof formatSchema>) { const { paths, setExitIfChanged, options = [] } = args; // Convert all relative paths to absolute paths const absolutePaths = toAbsolutePaths(paths); const cmdArgs = [ ...absolutePaths, ...(setExitIfChanged ? ['--set-exit-if-changed'] : []), ...options ]; const { stdout, stderr } = await executeDartCommand('format', cmdArgs); return { content: [ { type: "text" as const, text: stdout || stderr } ], isError: !!stderr }; }
- src/tools/format.ts:5-9 (schema)Zod schema defining the input parameters for the 'dart-format' tool: paths to format, setExitIfChanged flag, and optional additional options.export const formatSchema = z.object({ paths: z.array(z.string()).describe('Files or directories to format'), setExitIfChanged: z.boolean().default(false).describe('Return exit code 1 if there are any formatting changes'), options: z.array(z.string()).optional().describe('Additional format options') });
- src/index.ts:38-38 (registration)Registration of the 'dart-format' tool on the MCP server, linking the name, schema, and handler function.server.tool('dart-format', formatSchema.shape, format);
- src/index.ts:20-20 (registration)Import of the 'format' handler and 'formatSchema' used for the 'dart-format' tool.import { format, formatSchema } from './tools/format.js';
- src/config/mcp-config.ts:10-10 (schema)Tool description/capability for 'dart-format' in the MCP server configuration.'dart-format': "Idiomatically format Dart source code",