Skip to content

Commit 965ea8b

Browse files
committed
Enable check-symlinks pre-commit hook
Rationale: - Small but likely benefit in general, since there are no currently foreseen intentional use cases of committing of broken/dangling symlinks in this project. So such symlinks that arise are likely unintentional. - If the end-of-file-fixer hook has run on a Windows system where `core.symlinks` has *not* been set to `true`, and symlinks' paths have not been excluded, then a newline character is added to the end of the path held in the regular file Git checks out to stand in for the symlink. Because it is not actually a symlink, this will not detect the problem at that time (regardless of the order in which this and that hook run relative to each other). But when it is then run on CI on a system where symlinks are checked out, it will detect the problem.
1 parent bdfa280 commit 965ea8b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

Diff for: .pre-commit-config.yaml

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ repos:
2727
hooks:
2828
- id: end-of-file-fixer
2929
exclude: ^test/fixtures/
30+
- id: check-symlinks
3031
- id: check-toml
3132
- id: check-yaml
3233
- id: check-merge-conflict

0 commit comments

Comments
 (0)