如何为 Git 子模块配置独立的 Black 代码格式化规则(VS Code)

酷杰君_5279

酷杰君_5279

2026-11-01

421人浏览

原创

如何为 Git 子模块配置独立的 Black 代码格式化规则(VS Code)

VS Code 的 .vscode/settings.json 仅对当前工作区生效,无法自动按子目录或子模块继承不同 Python 格式化配置;需通过多根工作区(Multi-root Workspace)或语言特定设置组合实现真正的差异化 Black 参数(如 --line-length)。

vs code 的 `.vscode/settings.json` 仅对当前工作区生效,无法自动按子目录或子模块继承不同 python 格式化配置;需通过多根工作区(multi-root workspace)或语言特定设置组合实现真正的差异化 black 参数(如 `--line-length`)。

在大型项目中,主仓库与子模块可能遵循不同的代码风格规范(例如 PEP 8 兼容性要求、团队约定或历史遗留约束),尤其在 Black 格式化器的 --line-length 设置上常需差异化:主仓库和 sub_01 使用 150 字符,而 sub_02 严格限制为 100 字符。但直接在各子目录下放置独立的 .vscode/settings.json 并不能生效——VS Code 不支持“嵌套工作区继承”机制,它只会加载最外层打开的文件夹(即 main_repo/)的设置,子目录中的 settings.json 被完全忽略。

✅ 正确解法是使用 VS Code 多根工作区(Multi-root Workspace):

  1. 在 main_repo/ 目录下创建一个工作区文件,例如 main_repo.code-workspace;
  2. 编辑该文件,显式声明所有需独立配置的路径:
{
  "folders": [
    {
      "path": "."
    },
    {
      "path": "subs/sub_01"
    },
    {
      "path": "subs/sub_02"
    }
  ],
  "settings": {}
}
  1. 关闭当前窗口,用 VS Code 打开该 .code-workspace 文件(而非单纯打开文件夹);
  2. 此时每个文件夹将作为独立“根文件夹”,VS Code 支持为其分别配置 settings.json:
    • main_repo/.vscode/settings.json → 控制主仓库行为;
    • main_repo/subs/sub_01/.vscode/settings.json → 仅作用于 sub_01;
    • main_repo/subs/sub_02/.vscode/settings.json → 仅作用于 sub_02。

例如,在 sub_02/.vscode/settings.json 中可精确指定:

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "black-formatter.args": ["--line-length=100"],
  "python.defaultInterpreterPath": "./venv/bin/python"
}

⚠️ 注意事项:

git提交前检查
git提交前检查

在代码提交 git 前,通过 git diff 对比修改内容,逐文件审查变更点,检测潜在 BUG、隐含风险与可优化项,输出结构化审查报告。当用户表达提交前检查、提交检查、commit 前检查、pre-commit review、提前审查代码、检查一下改动、看看能不能提交等意图时使用此技能。注意:此技能与「代码评审」不同——代码评审在开发完成后结合需求文档与概要设计进行完整度审查,提交前检查是轻量级的基于 git diff 的代码质量把关。

下载
  • 确保已安装 Python 扩展 和 Black Formatter 扩展(v2023.10+);
  • black-formatter.args 是扩展级配置,不支持通配符或条件判断,必须静态定义;
  • 若启用 editor.formatOnType,建议统一设为 false(Black 不支持实时格式化);
  • 工作区设置优先级高于用户设置,但低于文件级设置(如 # fmt: off 注释);
  • 避免在 .vscode/ 中提交敏感配置(如 token、本地路径),推荐使用 .vscode/settings.json + .gitignore 过滤。

? 补充方案(轻量级):若无法使用多根工作区,可借助 Black 的配置文件层级机制,在各子模块根目录放置 pyproject.toml:

# subs/sub_02/pyproject.toml
[tool.black]
line-length = 100
include = '\.pyi?$'

VS Code 的 Black 扩展会自动读取该配置(需确保 black-formatter.args 未覆盖 --line-length,即完全删除该字段,交由 Black 自动发现)。

总结:VS Code 单一文件夹模式下无法实现子模块级 Black 差异化配置;唯一可靠路径是采用多根工作区 + 分散 .vscode/settings.json,辅以 pyproject.toml 声明式配置提升可移植性与团队一致性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git vs code

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
自建git服务器
自建git服务器

git服务器是目前流行的分布式版本控制系统之一,可以让多人协同开发同一个项目。本专题为大家提供自建git服务器相关的各种文章、以及下载和课程。

2023.07.05

6919

9

git和svn的区别
git和svn的区别

git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。

2023.07.06

1940

6

git撤销提交的commit
git撤销提交的commit

Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。

2023.07.24

1154

5

git提交错误怎么撤回
git提交错误怎么撤回

git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4497

7

git怎么对比两个版本的文件内容
git怎么对比两个版本的文件内容

要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2024.04.09

4341

6

vscode是什么_vscode怎么安装配置
vscode是什么_vscode怎么安装配置

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

2023.06.30

1495

18

vscode怎么运行代码
vscode怎么运行代码

vscode是一个运行于MacOS X、Windows和Linux之上的,针对于编写现代Web和云应用的跨平台源代码编辑器;vscode免费而且功能强大,对JavaScript和NodeJS的支持非常好,自带很多功能,例如代码格式化,代码智能提示补全、Emmet插件等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.21

3212

3

vscode使用的框架介绍
vscode使用的框架介绍

VSCode是一款跨平台代码编辑器,它基于Electron框架和Monaco Editor构建。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

2069

12

vscode一般用来写什么语言
vscode一般用来写什么语言

VSCode是一款功能强大的代码编辑器,支持多种编程语言和文件格式。它内置对 JavaScript、Python、Java、C++、TypeScript、HTML/CSS、Go 等语言的支持。想了解更多vscode的相关内容,可以阅读本专题下面的文章。

2024.03.14

1747

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 8.1万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.9万人学习