From 8fe064d0bd7ed0fbb665774f1aa77845ed56c99b Mon Sep 17 00:00:00 2001 From: Nuz / Lovegood Date: Sat, 8 Oct 2022 10:58:42 -0700 Subject: [PATCH 1/2] Alphabetize & clarify `file-contents-sorter` in README --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1026d3f..27dae97 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,17 @@ 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, for example: + +```yaml + - id: file-contents-sorter + files: \.gitignore +``` + +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 +132,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. From 14ac91fb70066f16a3093580c2f28de65837e138 Mon Sep 17 00:00:00 2001 From: Nuz / Lovegood Date: Sat, 8 Oct 2022 11:16:50 -0700 Subject: [PATCH 2/2] Remove example. --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 27dae97..6dcbf0d 100644 --- a/README.md +++ b/README.md @@ -116,13 +116,7 @@ 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, for example: - -```yaml - - id: file-contents-sorter - files: \.gitignore -``` - +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`