vscode配置pre-commit
时间: 2024-09-13 19:15:38 浏览: 153
pre-commit-vscode:提交前代码
Visual Studio Code (VSCode) 配置 `pre-commit` 主要是为了自动化代码提交前的一些校验步骤,比如格式化、代码风格检查、linting等。`pre-commit` 是一个流行的 Git 预提交钩子工具,它会在每次提交代码之前运行一系列命令。
以下是安装并设置 VSCode 配合 `pre-commit` 的基本步骤:
1. **安装 pre-commit**: 如果你还没有安装,可以使用 `pip` 安装:
```
pip install pre-commit
```
2. **初始化 git repository** 或者确保你在有 `.git` 文件夹的项目中:
```
cd your_project_directory
git init
```
3. **创建 `.pre-commit-config.yaml` 文件**,这是预提交钩子的主要配置文件:
```yaml
# .pre-commit-config.yaml
repo-hooks:
- id: black-format
name: Format with Black
entry: black .
language: system
types: [python]
- id: flake8
name: Run Flake8 Linting
entry: flake8 .
language: system
```
这里配置了两个示例钩子:Black 对 Python 代码进行格式化,Flake8 进行代码质量检查。
4. **添加钩子到仓库**:
```
pre-commit install
```
这将把配置的钩子添加到 `.git/hooks/pre-commit`,并在提交时自动运行它们。
5. **验证配置**:
提交一些更改,然后尝试提交,你会看到类似 `pre-commit run` 的输出,显示正在运行哪些钩子及结果。
阅读全文