Skip to content

fmt

Description

Format code using the configured formatters.

Optional Parameters: path: Path to code to format. Default: None - If not provided, formats all packages - Can be file or directory path - Must exist in workspace changed_only: Only format files that have changed. Default: False - Uses git to detect changes - Only formats files with uncommitted changes - Ignores untracked files

Usage: Format all packages: adev fmt

Format specific path:
    adev fmt -p ./my_package

Format only changed files:
    adev fmt --changed-only

Format specific path and only changed files:
    adev fmt -p ./my_package --changed-only

Notes

- Uses multiple formatters:
    - black: Python code formatting
    - isort: Import sorting
    - docformatter: Docstring formatting
- Supports parallel processing for faster formatting
- Shows formatting statistics on completion
- Exits with error if any formatting fails
- Can be integrated into pre-commit hooks
- Respects .gitignore patterns

Usage

adev fmt [OPTIONS] [ARGS]

Additionally, you can view the parameters for the command using:

adev fmt --help