clean

清理并格式化项目代码。默认工具链为 autoflake 与 black，可在 .autoship.toml 的 [clean] 段中自定义。

语法

autoship clean [OPTIONS] [PATHS]...

参数

名称	是否必填	说明
paths	否	要清理的路径，默认为当前目录（动态检测）

选项

短选项	长选项	默认值	说明
-	--check	False	若需要修改则返回非零退出码
-y	--yes	False	跳过交互式确认

示例

清理当前目录：

autoship clean

指定路径：

autoship clean src tests

CI 场景下检查是否需要格式化：

autoship clean --check

跳过确认：

autoship clean --yes

预期输出示例：

reformatted /path/to/project/hello.py

All done! ✨ 🍰 ✨
1 file reformatted.
Clean complete.

输出说明 / 常见错误

• --check 模式下如果文件需要修改，命令会返回非零退出码，适合在 CI 中使用。
• 若缺少配置的清理工具，会提示安装建议。
• 当 autoflake / black 等外部格式化工具不可用时，clean 会自动回退到内置格式化器。

内置格式化

当外部工具链不完整时，clean 使用内置格式化器处理以下文件类型：

.py .pyi .pyx .pxd .js .ts .jsx .tsx .rs .go .java .c .cpp .h .rb

处理范围： - 去掉行尾空白字符 - 合并连续空行为单个空行 - 压缩行内两个以上连续空格为单个空格（保留缩进和字符串字面量） - 确保文件以单个换行符结尾

相关命令

• verify — 运行验证
• commit — 提交改动