overcommit --run skips Git-quoted filenames with include filters

Abierto
  • ¿Algo no está bien?
#908 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
Medio día
Aptitud para principiantes
62/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
git, ruby
Área
devtools

Línea de trabajo

Start with GitRepo.all_files in lib/overcommit/git_repo.rb around lines 138-143, which splits both git ls-files and git ls-files --deleted output on newlines. Reproduce with the scratch-repo steps in the issue, using a filename such as café.rb under core.quotePath=true, then check whether the TrailingWhitespace hook reports a failure. Done means NUL-delimited parsing for both lists, with regression specs covering Unicode, quoted, control-character, nested, deleted, untracked, empty-index and broken-symlink paths.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Reproduced on current main 50f3e866bef75e3c3be7f92b47b1c45b6e7436ba (0.74.0), macOS 15.6.1, Ruby 4.0.7, Apple Git 2.50.1.

With Git's default core.quotePath=true, GitRepo.all_files returns the quoted/escaped output of git ls-files rather than actual paths. When a hook has an include pattern such as **/*.rb, those paths no longer match, and overcommit --run can report success without checking a tracked file.

Reproduction

Use a scratch repository, not an existing project:

mkdir overcommit-path-repro
cd overcommit-path-repro
git init
git config --local user.name 'Local Fixture'
git config --local user.email '[email protected]'
git config --local commit.gpgsign false
git config --local core.hooksPath /dev/null
git config --local core.quotePath true
git commit --allow-empty -m 'Initial fixture'

cat > .overcommit.yml <<'YAML'
PreCommit:
  ALL:
    enabled: false
  TrailingWhitespace:
    enabled: true
    on_warn: fail
    include:
      - '**/*.rb'
YAML

overcommit --sign
printf 'puts "fixture" \n' > normal.rb
git add -- normal.rb
overcommit --run
# TrailingWhitespace FAILED; exit 65.

git mv -- normal.rb 'café.rb'
overcommit --run
# All pre-commit hooks passed; exit 0. The content is unchanged.

git config --local core.quotePath false
overcommit --run
# TrailingWhitespace FAILED again; exit 65.

The same false-success result occurs for filenames containing double quotes, tabs, or newlines. core.quotePath=false is a control for the Unicode case, not a general workaround for those other characters.

Scope

GitRepo.all_files in lib/overcommit/git_repo.rb:138-143 splits both git ls-files and git ls-files --deleted on newlines. Using NUL-delimited output for both lists would avoid interpreting Git's C-style filename quoting while retaining the deleted-file filtering added in #905.

This behavior predates #905; I am not reporting it as a regression from that PR. The older #220/#222 discussion concerned a repository root containing spaces and list_files. I reproduced this with the repository root itself containing a space, and ordinary space-containing basenames still work.

The regression cases should include live Unicode/quoted/control-character paths, a nested Unicode path, unstaged deletions, an empty index, untracked files, and a tracked broken symlink. The broken symlink must remain visible to the BrokenSymlinks hook.

Would a small all_files parsing fix with these tests be welcome? I would leave other Git helpers, command execution, and index-error handling out of this change.

Lenguaje dominante
Ruby
Estrellas
4k
Forks
288
Merge medio
2 d 4 h
PR fusionados (30 d)
18

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de sds/overcommit

Todos los issues de sds/overcommit

Issues similares

Más issues de Ruby

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.