git-format-staged 3.1.0 → 3.1.2

package/README.md

@@ -1,7 +1,5 @@
 # git-format-staged
 
-[![Build Status](https://travis-ci.org/hallettj/git-format-staged.svg?branch=master)](https://travis-ci.org/hallettj/git-format-staged)
-
 Consider a project where you want all code formatted consistently. So you use
 a formatting command. (For example I use [prettier][] in my Javascript and
 Typescript projects.) You want to make sure that everyone working on the project
@@ -39,13 +37,13 @@ patch step can be disabled with the `--no-update-working-tree` option.
 
 Install via the CLI:
 
-    $ nix profile add github:hallettj/git-format-staged
+    $ nix profile install github:hallettj/git-format-staged
 
 Or add to your flake imports, and use the `default` package output.
 
 ### Install with NPM
 
-Requires Python version 3 or 2.7.
+Requires Python 3.8 or later.
 
 Install as a development dependency in a project that uses npm packages:
 
@@ -57,7 +55,7 @@ Or install globally:
 
 ### Or just copy the script
 
-Requires Python version 3 or 2.7.
+Requires Python 3.8 or later.
 
 If you do not use the above methods you can copy the
 [`git-format-staged`](./git-format-staged) script from this repository and
@@ -73,7 +71,7 @@ For detailed information run:
 The command expects a shell command to run a formatter, and one or more file
 patterns to identify which files should be formatted. For example:
 
-    $ git-format-staged --formatter 'prettier --stdin-filepath "{}"' 'src/*.js'
+    $ git-format-staged --formatter 'prettier --stdin-filepath {}' 'src/*.js'
 
 That will format all files under `src/` and its subdirectories using
 `prettier`. The file pattern is tested against staged files using Python's
@@ -90,11 +88,11 @@ normal shell globbing. So if you need to match multiple patterns, you should
 pass multiple arguments with different patterns, and they will be grouped.
 So instead of e.g. `'src/**/*.{js,jsx,ts}'`, you would use:
 
-    $ git-format-staged --formatter 'prettier --stdin-filepath "{}"' 'src/*.js' 'src/*.jsx' 'src/*.ts'
+    $ git-format-staged --formatter 'prettier --stdin-filepath {}' 'src/*.js' 'src/*.jsx' 'src/*.ts'
 
 Files can be excluded by prefixing a pattern with `!`. For example:
 
-    $ git-format-staged --formatter 'prettier --stdin-filepath "{}"' '*.js' '!flow-typed/*'
+    $ git-format-staged --formatter 'prettier --stdin-filepath {}' '*.js' '!flow-typed/*'
 
 Patterns are evaluated from left-to-right: if a file matches multiple patterns
 the right-most pattern determines whether the file is included or excluded.
@@ -104,11 +102,11 @@ control. So it is not necessary to explicitly exclude stuff like
 `node_modules/`.
 
 The formatter command may include a placeholder, `{}`, which will be replaced
-with the path of the file that is being formatted. This is useful if your
-formatter needs to know the file extension to determine how to format or to
-lint each file. For example:
+with the path of the file that is being formatted (with appropriate quoting).
+This is useful if your formatter needs to know the file extension to determine
+how to format or to lint each file. For example:
 
-    $ git-format-staged -f 'prettier --stdin-filepath "{}"' '*.js' '*.css'
+    $ git-format-staged -f 'prettier --stdin-filepath {}' '*.js' '*.css'
 
 Do not attempt to read or write to `{}` in your formatter command! The
 placeholder exists only for referencing the file name and path.
@@ -120,7 +118,7 @@ prevent files from being committed if they do not conform to style rules. You
 can use git-format-staged with the `--no-write` option, and supply a lint
 command instead of a format command. Here is an example using ESLint:
 
-    $ git-format-staged --no-write -f 'eslint --stdin --stdin-filename "{}" >&2' 'src/*.js'
+    $ git-format-staged --no-write -f 'eslint --stdin --stdin-filename {} >&2' 'src/*.js'
 
 If this command is run in a pre-commit hook, and the lint command fails the
 commit will be aborted and error messages will be displayed. The lint command
@@ -146,7 +144,7 @@ Add a `prepare` script to install husky when running `npm install`:
 
 Add the pre-commit hook:
 
-    $ npx husky add .husky/pre-commit "git-format-staged --formatter 'prettier --stdin-filepath \"{}\"' '*.js' '*.ts'"
+    $ npx husky add .husky/pre-commit "git-format-staged --formatter 'prettier --stdin-filepath {}' '*.js' '*.ts'"
     $ git add .husky/pre-commit
 
 Once again note that the formatter command and the `'*.js'` and `'*.ts'`

package/git-format-staged

@@ -7,9 +7,9 @@
 # ignoring unstaged changes.
 #
 # Usage: git-format-staged [OPTION]... [FILE]...
-# Example: git-format-staged --formatter 'prettier --stdin-filepath "{}"' '*.js'
+# Example: git-format-staged --formatter 'prettier --stdin-filepath {}' '*.js'
 #
-# Tested with Python 3.10 and Python 2.7.
+# Tested with Python versions 3.8 - 3.15.
 #
 # Original author: Jesse Hallett <jesse@sitr.us>
 
@@ -19,11 +19,12 @@ from fnmatch import fnmatch
 from gettext import gettext as _
 import os
 import re
+import shlex
 import subprocess
 import sys
 
-# The string 3.1.0 is replaced during the publish process.
-VERSION = '3.1.0'
+# The string 3.1.2 is replaced during the publish process.
+VERSION = '3.1.2'
 PROG = sys.argv[0]
 
 def info(msg):
@@ -37,14 +38,20 @@ def fatal(msg):
     exit(1)
 
 def format_staged_files(file_patterns, formatter, git_root, update_working_tree=True, write=True, verbose=False):
+    common_opts = [
+        '--cached',
+        '--diff-filter=AM', # select only file additions and modifications
+        '--no-renames',
+        'HEAD',
+    ]
+
     try:
-        output = subprocess.check_output([
-            'git', 'diff-index',
-            '--cached',
-            '--diff-filter=AM', # select only file additions and modifications
-            '--no-renames',
-            'HEAD'
-            ])
+        staged_files = {
+            path.decode('utf-8')
+            for path in subprocess.check_output(['git', 'diff', '--name-only'] + common_opts).splitlines()
+        }
+
+        output = subprocess.check_output(['git', 'diff-index'] + common_opts)
         for line in output.splitlines():
             entry = parse_diff(line.decode('utf-8'))
             entry_path = normalize_path(entry['src_path'], relative_to=git_root)
@@ -53,6 +60,9 @@ def format_staged_files(file_patterns, formatter, git_root, update_working_tree=
                 continue
             if not (matches_some_path(file_patterns, entry_path)):
                 continue
+            if entry['src_mode'] is None and object_is_empty(entry['dst_hash']) and entry['src_path'] not in staged_files:
+                # File is not staged, it's tracked only with `--intent-to-add` and won't get committed
+                continue
             if format_file_in_index(formatter, entry, update_working_tree=update_working_tree, write=write, verbose=verbose):
                 info('Reformatted {} with {}'.format(entry['src_path'], formatter))
     except Exception as err:
@@ -86,7 +96,10 @@ def format_file_in_index(formatter, diff_entry, update_working_tree=True, write=
 
     return new_hash
 
-file_path_placeholder = re.compile('\{\}')
+# Match {}, and to avoid breaking quoting from shlex also match and remove surrounding quotes. This
+# is important for backward compatibility because previous version of git-format-staged did not use
+# shlex quoting, and required manual quoting.
+file_path_placeholder = re.compile(r"(['\"]?)\{\}(\1)")
 
 # Run formatter on a git blob identified by its hash. Writes output to a new git
 # blob, and returns the hash of the new blob.
@@ -95,7 +108,7 @@ def format_object(formatter, object_hash, file_path, verbose=False):
             ['git', 'cat-file', '-p', object_hash],
             stdout=subprocess.PIPE
             )
-    command = re.sub(file_path_placeholder, file_path, formatter)
+    command = re.sub(file_path_placeholder, shlex.quote(file_path), formatter)
     if verbose:
         info(command)
     format_content = subprocess.Popen(
@@ -110,16 +123,15 @@ def format_object(formatter, object_hash, file_path, verbose=False):
             stdout=subprocess.PIPE
             )
 
-    get_content.stdout.close()
-    format_content.stdout.close()
+    # Read output from the final process first to avoid deadlock if intermediate processes produce
+    # large outputs that would fill pipe buffers
+    new_hash, _ = write_object.communicate()
 
     if get_content.wait() != 0:
         raise ValueError('unable to read file content from object database: ' + object_hash)
 
     if format_content.wait() != 0:
-        raise Exception('formatter exited with non-zero status') # TODO: capture stderr from format command
-
-    new_hash, err = write_object.communicate()
+        raise Exception('formatter exited with non-zero status')
 
     if write_object.returncode != 0:
         raise Exception('unable to write formatted content to object database')
@@ -167,7 +179,7 @@ def patch_working_file(path, orig_object_hash, new_object_hash):
         raise Exception('could not apply formatting changes to working tree file {}'.format(path))
 
 # Format: src_mode dst_mode src_hash dst_hash status/score? src_path dst_path?
-diff_pat = re.compile('^:(\d+) (\d+) ([a-f0-9]+) ([a-f0-9]+) ([A-Z])(\d+)?\t([^\t]+)(?:\t([^\t]+))?$')
+diff_pat = re.compile(r'^:(\d+) (\d+) ([a-f0-9]+) ([a-f0-9]+) ([A-Z])(\d+)?\t([^\t]+)(?:\t([^\t]+))?$')
 
 # Parse output from `git diff-index`
 def parse_diff(diff):
@@ -185,7 +197,7 @@ def parse_diff(diff):
             'dst_path': m.group(8)
             }
 
-zeroed_pat = re.compile('^0+$')
+zeroed_pat = re.compile(r'^0+$')
 
 # Returns the argument unless the argument is a string of zeroes, in which case
 # returns `None`
@@ -234,12 +246,12 @@ class CustomArgumentParser(argparse.ArgumentParser):
 if __name__ == '__main__':
     parser = CustomArgumentParser(
             description='Transform staged files using a formatting command that accepts content via stdin and produces a result via stdout.',
-            epilog='Example: %(prog)s --formatter "prettier --stdin-filepath \'{}\'" "src/*.js" "test/*.js"'
+            epilog='Example: %(prog)s --formatter "prettier --stdin-filepath {}" "src/*.js" "test/*.js"'
             )
     parser.add_argument(
             '--formatter', '-f',
             required=True,
-            help='Shell command to format files, will run once per file. Occurrences of the placeholder `{}` will be replaced with a path to the file being formatted. (Example: "prettier --stdin-filepath \'{}\'")'
+            help='Shell command to format files, will run once per file. Occurrences of the placeholder `{}` will be replaced with a path to the file being formatted (with appropriate quoting). (Example: "prettier --stdin-filepath {}")'
             )
     parser.add_argument(
             '--no-update-working-tree',
@@ -249,7 +261,7 @@ if __name__ == '__main__':
     parser.add_argument(
             '--no-write',
             action='store_true',
-            help='Prevents %(prog)s from modifying staged or working tree files. You can use this option to check staged changes with a linter instead of formatting. With this option stdout from the formatter command is ignored. Example: %(prog)s --no-write -f "eslint --stdin --stdin-filename \'{}\' >&2" "*.js"'
+            help='Prevents %(prog)s from modifying staged or working tree files. You can use this option to check staged changes with a linter instead of formatting. With this option stdout from the formatter command is ignored. Example: %(prog)s --no-write -f "eslint --stdin --stdin-filename {} >&2" "*.js"'
             )
     parser.add_argument(
             '--version',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-format-staged",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "Git command to transform staged files according to a command that accepts file content on stdin and produces output on stdout.",
   "scripts": {
     "test": "ava",
@@ -29,17 +29,17 @@
     "git-format-staged"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
+    "@commitlint/cli": "^19.0.3",
+    "@commitlint/config-conventional": "^19.0.3",
     "@types/fs-extra": "^8.1.0",
     "@types/tmp": "^0.1.0",
     "ava": "^3.8.1",
     "eslint": "^5.16.0",
     "fs-extra": "^9.0.0",
-    "husky": "^4.2.5",
+    "husky": "^9.0.11",
     "micromatch": "^4.0.2",
     "prettier-standard": "^9.1.1",
-    "semantic-release": "^19.0.2",
+    "semantic-release": "^23.0.2",
     "strip-indent": "^3.0.0",
     "tmp": "0.2.0",
     "ts-node": "^8.9.1",