summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2023-01-20 17:33:25 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2023-01-20 17:33:33 +0000
commitc8fc72f1edcbd73ac385910f091fae53437977e0 (patch)
treefb574df36cbb0324f2fac74891c73bf47bcccc41 /README.md
parentReleasing debian version 4.3.0+dfsg-1. (diff)
downloadpre-commit-hooks-c8fc72f1edcbd73ac385910f091fae53437977e0.tar.xz
pre-commit-hooks-c8fc72f1edcbd73ac385910f091fae53437977e0.zip
Merging upstream version 4.4.0+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/README.md b/README.md
index 411529a..9aa966d 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,7 @@ Add this to your `.pre-commit-config.yaml`
```yaml
- repo: https://github.com/pre-commit/pre-commit-hooks
- rev: v4.3.0 # Use the ref you want to point at
+ rev: v4.4.0 # Use the ref you want to point at
hooks:
- id: trailing-whitespace
# - id: ...
@@ -114,6 +114,11 @@ This hook replaces double quoted strings with single quoted strings.
#### `end-of-file-fixer`
Makes sure files end in a newline and only a newline.
+#### `file-contents-sorter`
+Sort the lines in specified files (defaults to alphabetical).
+You must provide the target [`files`](https://pre-commit.com/#config-files) as input.
+Note that this hook WILL remove blank lines and does NOT respect any comments.
+
#### `fix-byte-order-marker`
removes UTF-8 byte order marker
@@ -121,11 +126,6 @@ removes UTF-8 byte order marker
Add `# -*- coding: utf-8 -*-` to the top of python files.
- To remove the coding pragma pass `--remove` (useful in a python3-only codebase)
-#### `file-contents-sorter`
-Sort the lines in specified files (defaults to alphabetical).
-You must provide list of target files as input to it.
-Note that this hook WILL remove blank lines and does NOT respect any comments.
-
The following arguments are available:
- `--ignore-case` - fold lower case to upper case characters.
- `--unique` - ensure each line is unique.
@@ -133,6 +133,12 @@ The following arguments are available:
#### `forbid-new-submodules`
Prevent addition of new git submodules.
+This is intended as a helper to migrate away from submodules. If you want to
+ban them entirely use `forbid-submodules`
+
+#### `forbid-submodules`
+forbids any submodules in the repository.
+
#### `mixed-line-ending`
Replaces or checks mixed line ending.
- `--fix={auto,crlf,lf,no}`