如何在VS Code中运行Cirq仓库的format-incremental格式化脚本？

先搞懂脚本基础用法 #

• 打开VS Code并加载你的Cirq仓库文件夹，打开内置终端（快捷键Ctrl+``），切换到仓库根目录：cd /path/to/your/cirq-repo`
• 给脚本添加执行权限（第一次运行需要）：chmod +x format-incremental
• 运行./format-incremental --help查看参数说明，这是最直接的用法指南，比如大部分情况下：
  • 仅格式化你修改过的文件：直接运行./format-incremental
  • 格式化仓库所有Python文件：运行./format-incremental --all（参数以实际帮助输出为准）

两种在VS Code里用脚本的方式 #

方式一：直接在VS Code终端运行 #

• 确认终端路径是仓库根目录，根据需求执行对应命令即可。比如修改了几个文件，想快速格式化，直接敲./format-incremental回车就行。

方式二：配置成VS Code默认格式化工具（更省心） #

• 打开VS Code设置（快捷键Ctrl+,），搜索「Python Formatting Provider」，选择「Custom」
• 搜索「Python > Formatting: Custom Path」，填入format-incremental脚本的绝对路径，比如/Users/xxx/Documents/cirq/format-incremental
• 搜索「Python > Formatting: Custom Args」，根据需求填参数：
  • 增量格式化：留空（默认处理修改过的文件）
  • 格式化所有文件：填入--all
• 配置完成后，选中要格式化的Python文件，按Ctrl+Shift+I就能直接用这个脚本格式化了。

常见问题排查 #

• 如果脚本跑不起来，先检查是否装了依赖工具：Cirq的格式化脚本一般依赖black和isort，终端里跑pip install black isort安装就行
• 要是终端提示找不到脚本，确认当前路径是仓库根目录，或者用绝对路径执行脚本
• 增量格式化没生效？看看你修改的文件有没有被git追踪（用git status检查），大部分增量脚本只处理已被git记录的修改文件

内容的提问来源于stack exchange，提问作者beginnerCoder7