git-format-staged 2.1.3 → 3.1.0

package/README.md

@@ -3,10 +3,10 @@
 [![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-standard][] in my
-Javascript projects.) You want to make sure that everyone working on the
-project runs the formatter, so you use a tool like [husky][] to install a git
-pre-commit hook. The naive way to write that hook would be to:
+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
+runs the formatter, so you use a tool like [husky][] to install a git pre-commit
+hook. The naive way to write that hook would be to:
 
 - get a list of staged files
 - run the formatter on those files
@@ -30,12 +30,21 @@ version of the file that is committed will be formatted properly - the warning
 just means that working tree copy of the file has been left unformatted. The
 patch step can be disabled with the `--no-update-working-tree` option.
 
-[prettier-standard]: https://www.npmjs.com/package/prettier-standard
+[prettier]: https://prettier.io/
 [husky]: https://www.npmjs.com/package/husky
 
-
 ## 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:
@@ -46,12 +55,15 @@ 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.
 
-
 ## How to use
 
 For detailed information run:
@@ -73,6 +85,13 @@ file names.
 The formatter command must read file content from `stdin`, and output formatted
 content to `stdout`.
 
+Note that the syntax of the `fnmatch` glob match is a is a bit different from
+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'
+
 Files can be excluded by prefixing a pattern with `!`. For example:
 
     $ git-format-staged --formatter 'prettier --stdin-filepath "{}"' '*.js' '!flow-typed/*'
@@ -116,23 +135,26 @@ notation) so that you can see them.
 Follow these steps to automatically format all Javascript files on commit in
 a project that uses npm.
 
-Install git-format-staged, husky, and a formatter (I use prettier-standard):
+Install git-format-staged, husky, and a formatter (I use `prettier`):
 
-    $ npm install --save-dev git-format-staged husky prettier-standard
+    $ npm install --save-dev git-format-staged husky prettier
 
-Add a `"precommit"` script in `package.json`:
+Add a `prepare` script to install husky when running `npm install`:
 
-    "scripts": {
-      "precommit": "git-format-staged -f prettier-standard '*.js'"
-    }
+    $ npm set-script prepare "husky install"
+    $ npm run prepare
 
-Once again note that the `'*.js'` pattern is quoted! If the formatter command
-included arguments it would also need to be quoted.
+Add the pre-commit hook:
+
+    $ 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'`
+patterns are quoted!
 
 That's it! Whenever a file is changed as a result of formatting on commit you
 will see a message in the output from `git commit`.
 
-
 ## Comparisons to similar utilities
 
 There are other tools that will format or lint staged files. What distinguishes

package/git-format-staged

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 #
 # Git command to transform staged files according to a command that accepts file
 # content on stdin and produces output on stdout. This command is useful in
@@ -9,7 +9,7 @@
 # Usage: git-format-staged [OPTION]... [FILE]...
 # Example: git-format-staged --formatter 'prettier --stdin-filepath "{}"' '*.js'
 #
-# Tested with Python 3.6 and Python 2.7.
+# Tested with Python 3.10 and Python 2.7.
 #
 # Original author: Jesse Hallett <jesse@sitr.us>
 
@@ -22,12 +22,12 @@ import re
 import subprocess
 import sys
 
-# The string 2.1.3 is replaced during the publish process.
-VERSION = '2.1.3'
+# The string 3.1.0 is replaced during the publish process.
+VERSION = '3.1.0'
 PROG = sys.argv[0]
 
 def info(msg):
-    print(msg, file=sys.stderr)
+    print(msg, file=sys.stdout)
 
 def warn(msg):
     print('{}: warning: {}'.format(PROG, msg), file=sys.stderr)
@@ -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:
@@ -90,13 +90,16 @@ file_path_placeholder = re.compile('\{\}')
 
 # 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', 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
@@ -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": "2.1.3",
+  "version": "3.1.0",
   "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",
@@ -28,9 +28,6 @@
   "files": [
     "git-format-staged"
   ],
-  "release": {
-    "branches": "master"
-  },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^8.3.4",
@@ -42,7 +39,7 @@
     "husky": "^4.2.5",
     "micromatch": "^4.0.2",
     "prettier-standard": "^9.1.1",
-    "semantic-release": "^17.2.3",
+    "semantic-release": "^19.0.2",
     "strip-indent": "^3.0.0",
     "tmp": "0.2.0",
     "ts-node": "^8.9.1",