git-format-staged 3.0.0 → 3.1.1

package/README.md

@@ -35,6 +35,16 @@ patch step can be disabled with the `--no-update-working-tree` option.
 
 ## How to install
 
+### Install with Nix
+
+Install via the CLI:
+
+    $ nix profile add 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.
 
 Install as a development dependency in a project that uses npm packages:
@@ -45,7 +55,11 @@ Or install globally:
 
     $ npm install --global git-format-staged
 
-If you do not use npm you can copy the
+### Or just copy the script
+
+Requires Python version 3 or 2.7.
+
+If you do not use the above methods you can copy the
 [`git-format-staged`](./git-format-staged) script from this repository and
 place it in your executable path. The script is MIT-licensed - so you can check
 the script into version control in your own open source project if you wish.

package/git-format-staged

@@ -22,8 +22,8 @@ import re
 import subprocess
 import sys
 
-# The string 3.0.0 is replaced during the publish process.
-VERSION = '3.0.0'
+# The string 3.1.1 is replaced during the publish process.
+VERSION = '3.1.1'
 PROG = sys.argv[0]
 
 def info(msg):
@@ -36,7 +36,7 @@ def fatal(msg):
     print('{}: error: {}'.format(PROG, msg), file=sys.stderr)
     exit(1)
 
-def format_staged_files(file_patterns, formatter, git_root, update_working_tree=True, write=True):
+def format_staged_files(file_patterns, formatter, git_root, update_working_tree=True, write=True, verbose=False):
     try:
         output = subprocess.check_output([
             'git', 'diff-index',
@@ -53,7 +53,7 @@ def format_staged_files(file_patterns, formatter, git_root, update_working_tree=
                 continue
             if not (matches_some_path(file_patterns, entry_path)):
                 continue
-            if format_file_in_index(formatter, entry, update_working_tree=update_working_tree, write=write):
+            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:
         fatal(str(err))
@@ -61,9 +61,9 @@ def format_staged_files(file_patterns, formatter, git_root, update_working_tree=
 # Run formatter on file in the git index. Creates a new git object with the
 # result, and replaces the content of the file in the index with that object.
 # Returns hash of the new object if formatting produced any changes.
-def format_file_in_index(formatter, diff_entry, update_working_tree=True, write=True):
+def format_file_in_index(formatter, diff_entry, update_working_tree=True, write=True, verbose=False):
     orig_hash = diff_entry['dst_hash']
-    new_hash = format_object(formatter, orig_hash, diff_entry['src_path'])
+    new_hash = format_object(formatter, orig_hash, diff_entry['src_path'], verbose=verbose)
 
     # If the new hash is the same then the formatter did not make any changes.
     if not write or new_hash == orig_hash:
@@ -86,17 +86,20 @@ def format_file_in_index(formatter, diff_entry, update_working_tree=True, write=
 
     return new_hash
 
-file_path_placeholder = re.compile('\{\}')
+file_path_placeholder = re.compile(r'\{\}')
 
 # 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.
-def format_object(formatter, object_hash, file_path):
+def format_object(formatter, object_hash, file_path, verbose=False):
     get_content = subprocess.Popen(
             ['git', 'cat-file', '-p', object_hash],
             stdout=subprocess.PIPE
             )
+    command = re.sub(file_path_placeholder, file_path, formatter)
+    if verbose:
+        info(command)
     format_content = subprocess.Popen(
-            re.sub(file_path_placeholder, file_path, formatter),
+            command,
             shell=True,
             stdin=get_content.stdout,
             stdout=subprocess.PIPE
@@ -145,7 +148,7 @@ def replace_file_in_index(diff_entry, new_object_hash):
 
 def patch_working_file(path, orig_object_hash, new_object_hash):
     patch = subprocess.check_output(
-            ['git', 'diff', '--color=never', orig_object_hash, new_object_hash]
+            ['git', 'diff', '--no-ext-diff', '--color=never', orig_object_hash, new_object_hash]
             )
 
     # Substitute object hashes in patch header with path to working tree file
@@ -164,7 +167,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):
@@ -182,7 +185,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`
@@ -254,6 +257,11 @@ if __name__ == '__main__':
             version='%(prog)s version {}'.format(VERSION),
             help='Display version of %(prog)s'
             )
+    parser.add_argument(
+            '--verbose',
+            help='Show the formatting commands that are running',
+            action='store_true'
+            )
     parser.add_argument(
             'files',
             nargs='+',
@@ -266,5 +274,6 @@ if __name__ == '__main__':
             formatter=vars(args)['formatter'],
             git_root=get_git_root(),
             update_working_tree=not vars(args)['no_update_working_tree'],
-            write=not vars(args)['no_write']
+            write=not vars(args)['no_write'],
+            verbose=vars(args)['verbose']
             )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "git-format-staged",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "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",