Format

invoke_tasklib.format ¶

Code and docstring formatting tasks.

Naming convention: check_<target> tasks are read-only (they fail without modifying files); fix_<target> tasks modify files in place.

check_docstrings(c: Context) -> None

Check docstring formatting with docformatter without modifying files.

check_python(c: Context) -> None

Check code format with ruff without modifying files.

check_shell(c: Context) -> None

Check shell scripts with shellcheck.

fix_docstrings(c: Context) -> None

Format docstrings in source code with docformatter.

Note

This modifies files in place. Ensure your work is committed before running this task.

fix_python(c: Context) -> None

Format code in place with ruff.

Note

This modifies files in place. Ensure your work is committed before running this task.

fix_shell(c: Context) -> None

Format shell scripts in place with shfmt.

Note

This modifies files in place. Ensure your work is committed before running this task.