git-format-staged 2.0.0 → 2.1.3

package/README.md

@@ -61,7 +61,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' '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
@@ -75,7 +75,7 @@ content to `stdout`.
 
 Files can be excluded by prefixing a pattern with `!`. For example:
 
-    $ git-format-staged --formatter 'prettier --stdin' '*.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.
@@ -84,6 +84,16 @@ git-format-staged never operates on files that are excluded from version
 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:
+
+    $ 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.
+
 ### Check staged changes with a linter without formatting
 
 Perhaps you do not want to reformat files automatically; but you do want to
@@ -91,7 +101,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 >&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
@@ -166,6 +176,10 @@ Some more comparisons:
   lint-staged does provide powerful configuration options around which files
   should be linted or formatted, what should happen before and after linting,
   and so on.
+- [pretty-quick][] formats staged files with prettier. By default pretty-quick
+  will abort the commit if files are partially staged to allow the user to
+  decide how to re-stage changes from formatting. The result is more manual
+  effort compared to git-format-staged.
 - the one-liner
   `git diff --diff-filter=d --cached | grep '^[+-]' | grep -Ev '^(--- a/|\+\+\+ b/)' | LINT_COMMAND`
   (described [here][lint changed hunks]) extracts changed hunks and feeds them
@@ -175,5 +189,6 @@ Some more comparisons:
 
 [precise-commits]: https://github.com/nrwl/precise-commits
 [pre-commit]: https://pre-commit.com/#pre-commit-during-commits
+[pretty-quick]: https://www.npmjs.com/package/pretty-quick
 [lint-staged]: https://github.com/okonet/lint-staged
 [lint changed hunks]: https://github.com/okonet/lint-staged/issues/62#issuecomment-383217916

package/git-format-staged

@@ -7,7 +7,7 @@
 # ignoring unstaged changes.
 #
 # Usage: git-format-staged [OPTION]... [FILE]...
-# Example: git-format-staged --formatter 'prettier --stdin' '*.js'
+# Example: git-format-staged --formatter 'prettier --stdin-filepath "{}"' '*.js'
 #
 # Tested with Python 3.6 and Python 2.7.
 #
@@ -22,8 +22,8 @@ import re
 import subprocess
 import sys
 
-# The string 2.0.0 is replaced during the publish process.
-VERSION = '2.0.0'
+# The string 2.1.3 is replaced during the publish process.
+VERSION = '2.1.3'
 PROG = sys.argv[0]
 
 def info(msg):
@@ -48,6 +48,9 @@ def format_staged_files(file_patterns, formatter, git_root, update_working_tree=
         for line in output.splitlines():
             entry = parse_diff(line.decode('utf-8'))
             entry_path = normalize_path(entry['src_path'], relative_to=git_root)
+            if entry['dst_mode'] == '120000':
+                # Do not process symlinks
+                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):
@@ -60,12 +63,18 @@ def format_staged_files(file_patterns, formatter, git_root, update_working_tree=
 # 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):
     orig_hash = diff_entry['dst_hash']
-    new_hash = format_object(formatter, orig_hash)
+    new_hash = format_object(formatter, orig_hash, diff_entry['src_path'])
 
     # If the new hash is the same then the formatter did not make any changes.
     if not write or new_hash == orig_hash:
         return None
 
+    # If the content of the new object is empty then the formatter did not
+    # produce any output. We want to abort instead of replacing the file with an
+    # empty one.
+    if object_is_empty(new_hash):
+        return None
+
     replace_file_in_index(diff_entry, new_hash)
 
     if update_working_tree:
@@ -77,16 +86,17 @@ def format_file_in_index(formatter, diff_entry, update_working_tree=True, write=
 
     return new_hash
 
+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):
+def format_object(formatter, object_hash, file_path):
     get_content = subprocess.Popen(
             ['git', 'cat-file', '-p', object_hash],
             stdout=subprocess.PIPE
             )
     format_content = subprocess.Popen(
-            formatter,
+            re.sub(file_path_placeholder, file_path, formatter),
             shell=True,
             stdin=get_content.stdout,
             stdout=subprocess.PIPE
@@ -113,6 +123,18 @@ def format_object(formatter, object_hash):
 
     return new_hash.decode('utf-8').rstrip()
 
+def object_is_empty(object_hash):
+    get_content = subprocess.Popen(
+            ['git', 'cat-file', '-p', object_hash],
+            stdout=subprocess.PIPE
+        )
+    content, err = get_content.communicate()
+
+    if get_content.returncode != 0:
+        raise Exception('unable to verify content of formatted object')
+
+    return not content
+
 def replace_file_in_index(diff_entry, new_object_hash):
     subprocess.check_call(['git', 'update-index',
         '--cacheinfo', '{},{},{}'.format(
@@ -209,12 +231,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" "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. (Example: "prettier --stdin")'
+            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 \'{}\'")'
             )
     parser.add_argument(
             '--no-update-working-tree',
@@ -224,7 +246,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 >&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,15 +1,15 @@
 {
   "name": "git-format-staged",
-  "version": "2.0.0",
+  "version": "2.1.3",
   "description": "Git command to transform staged files according to a command that accepts file content on stdin and produces output on stdout.",
   "scripts": {
-    "precommit": "./git-format-staged --formatter prettier-standard '*.js'",
-    "commitmsg": "commitlint -e $GIT_PARAMS",
     "test": "ava",
     "prepublishOnly": "sed -i \"s/\\$VERSION/$npm_package_version/\" git-format-staged",
     "semantic-release": "semantic-release"
   },
-  "bin": "./git-format-staged",
+  "bin": {
+    "git-format-staged": "git-format-staged"
+  },
   "main": "./no-main.js",
   "repository": {
     "type": "git",
@@ -29,32 +29,40 @@
     "git-format-staged"
   ],
   "release": {
-    "branch": "master"
+    "branches": "master"
   },
   "devDependencies": {
-    "@babel/plugin-transform-flow-strip-types": "^7.0.0-beta.46",
-    "@commitlint/cli": "^6.2.0",
-    "@commitlint/config-angular": "^6.1.3",
-    "ava": "^1.0.0-beta.4",
-    "flow-bin": "^0.72.0",
-    "fs-extra": "^6.0.1",
-    "husky": "^0.14.3",
-    "prettier-standard": "^8.0.1",
-    "semantic-release": "^15.5.0",
-    "strip-indent": "^2.0.0",
-    "tmp": "0.0.33"
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^8.3.4",
+    "@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",
+    "micromatch": "^4.0.2",
+    "prettier-standard": "^9.1.1",
+    "semantic-release": "^17.2.3",
+    "strip-indent": "^3.0.0",
+    "tmp": "0.2.0",
+    "ts-node": "^8.9.1",
+    "typescript": "^3.8.3"
   },
   "ava": {
-    "babel": {
-      "testOptions": {
-        "plugins": [
-          "@babel/plugin-transform-flow-strip-types"
-        ]
-      }
-    },
-    "color": false,
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ],
     "files": [
-      "test/**/*_test.js"
+      "test/**/*_test.ts"
     ]
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -e $HUSKY_GIT_PARAMS",
+      "pre-commit": "./git-format-staged --formatter prettier-standard '*.js'"
+    }
   }
 }