duolingo/pre-commit-hooks

pre-commit hooks 镜像文档

镜像概述和主要用途

该镜像包含一个pre-commit钩子，可在内部并行运行多个代码格式化工具，用于自动化代码格式化和风格统一。Duolingo已在开发者工作站和CI环境中对所有生产仓库强制执行此钩子，确保代码风格一致性。

核心功能和特性

支持的格式化工具及版本

• Prettier v2.3.2：支持CSS、HTML、JS、JSX、Markdown、Sass、TypeScript、YAML
• Black v21.7b0：支持Python
• autoflake v1.4：支持Python
• isort v5.9.3：支持Python
• google-java-format v1.11.0：支持Java
• ktfmt v0.28：支持Kotlin
• scalafmt v2.7.5：支持Scala
• shfmt v3.3.1：支持Shell
• terraform fmt v0.11.14 和 v0.12.29：支持Terraform
• ClangFormat v11.1.0：支持Protobuf
• SVGO v1.3.2：支持SVG

自定义正则转换

基于sed的自定义正则转换，包括：

• 修剪尾随空格和换行符
• 移除Python 3中不必要的coding pragmas和object基类
• 将空Python集合（如list()）替换为字面量等价形式
• 将空Kotlin集合（如arrayOf()）替换为empty等价形式

其他特性

• 默认排除build和node_modules目录，无需在钩子的exclude配置中声明

使用场景和适用范围

适用场景

• 开发者本地开发环境：在提交代码前自动格式化，确保本地代码风格一致
• 持续集成(CI)环境：作为代码提交的前置检查，强制代码风格规范，拒绝未格式化的代码提交

适用范围

• 支持多种编程语言和文件类型：CSS、HTML、JavaScript、JSX、Markdown、Sass、TypeScript、YAML、Python、Java、Kotlin、Scala、Shell、Terraform、Protobuf、SVG等
• 适用于需要统一团队代码风格、减少代码审查中格式相关问题的项目

使用方法和配置说明

配置pre-commit钩子

仓库维护者需在项目根目录的.pre-commit-config.yaml中声明该钩子：

yaml
- repo: https://github.com/duolingo/pre-commit-hooks.git
  rev: 1.5.2  # 使用最新的稳定版本号
  hooks:
    - id: duolingo
      args: [--python-version=2]  # 可选，指定Python版本，默认为Python 3

参数说明

• args：可选配置，目前支持--python-version参数，指定Python版本（如2或3），默认为Python 3

排除目录

build和node_modules目录默认被排除，无需额外在钩子配置中添加exclude键。

同步编辑器配置

贡献者可将本仓库的.editorconfig文件复制到个人主目录（如~/.editorconfig），使文本编辑器和IDE自动应用与该钩子相同的格式化规则，确保编辑器设置与钩子行为一致。