git_stage_formatter 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e24f5f48a24491053f2e2220ce055df6f61c6207a750f5a8ff6098afbde4120a
-  data.tar.gz: 54553233ebdb102c78ab79d8a660c12f8df10647f3cfb65c22397516d8f0b965
+  metadata.gz: eef46e1e61e9298617a81667ae1d75dda336b9abae96da8d3f31f504e7a369e7
+  data.tar.gz: 315e59902076c09d46b87c57ddd580819860b4e5919085c0d232dd59ca7cf0ed
 SHA512:
-  metadata.gz: 20911e08c4169554122387169899c2d93f9b0be2ef7d305370c059dba9be6ab88a8553efdbf0fbb74598a31ea62cc7945a04dcb416379fb7abef8f1d677700f4
-  data.tar.gz: d86c46ed60800b49fd8ee4132226e97483a1fb15060d08642984d55fc23096f2d8147ea04a835763d48ef8c25ff1e05d7afd87472f6a8a745039b41872bc0b9c
+  metadata.gz: 38b0689f0aa55e86523f8081ff222b48933613df2df159c6ac9a6bd7c27d865d438e7bc2d6e7e899299b0dcf15492c46fd8b5925164717978a7a4323d9f3ac95
+  data.tar.gz: cc11ea3ed725beaa56c164f882d19ac589dc0f4e6f3dfc3ba401a32af6d3600ef627be690611900bee82e1ba032bda49607e6686893a70039225ead123dfe139

data/.gitignore

@@ -5,6 +5,7 @@ yarn-error.log
 # Ruby
 .bundle
 Gemfile.lock
+/pkg/
 
 # Misc
 .DS_Store

data/.releaserc.yaml

@@ -0,0 +1,3 @@
+branches:
+  - +([0-9])?(.{+([0-9]),x}).x  # maintenance branches of the form 2.x
+  - release                     # pushes to `release` branch trigger automatic publish

data/.travis.yml

@@ -1,7 +1,8 @@
+dist: focal
 language: python
 python:
-  - 3.8
-  - 3.6
+  - 3.10
+  - 3.9
   - 2.7
 
 cache:

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 2.2.0 - RubyGem Support!
+
+#### 2021-05-22
+
+- Initial RubyGem support! Now you can install this script by adding `gem 'git_stage_formatter'` to your Gemfile, or by running `gem install git_stage_formatter` 🎉

data/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,14 +30,15 @@ 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
 
 Requires Python version 3 or 2.7.
 
+### npm
+
 Install as a development dependency in a project that uses npm packages:
 
     $ npm install --save-dev git-format-staged
@@ -46,11 +47,25 @@ Or install globally:
 
     $ npm install --global git-format-staged
 
-If you do not use npm 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.
+### bundler
+
+Add this gem to your Gemfile:
+
+```ruby
+gem 'git_stage_formatter'
+```
+
+### gem
+
+Install the binary via gem:
+
+```sh
+gem install git_stage_formatter
+```
 
+### Manually
+
+If you don't use `npm`, `bundler` or `gem`, you can copy the [`git-format-staged`](./git-format-staged) script from this repository and place it in your executable path, or somewhere convenient. 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
 
@@ -61,7 +76,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 --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
@@ -73,9 +88,16 @@ 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' '*.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.
@@ -89,7 +111,7 @@ 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 --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.
@@ -116,23 +138,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

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/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
@@ -7,9 +7,9 @@
 # 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.
+# Tested with Python 3.10 and Python 2.7.
 #
 # Original author: Jesse Hallett <jesse@sitr.us>
 
@@ -27,7 +27,7 @@ VERSION = '$VERSION'
 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)
@@ -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):
@@ -142,7 +145,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', '--color=never', orig_object_hash, new_object_hash]
             )
 
     # Substitute object hashes in patch header with path to working tree file
@@ -228,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. Occurrences of the placeholder `{}` will be replaced with a path to the file being formatted. (Example: "prettier --stdin --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. (Example: "prettier --stdin-filepath \'{}\'")'
             )
     parser.add_argument(
             '--no-update-working-tree',

data/git_stage_formatter.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/git_stage_formatter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_stage_formatter"
+  spec.version       = GitStageFormatter::VERSION
+  spec.authors       = ["Roger Oba"]
+  spec.email         = ["rogerluan.oba@gmail.com"]
+  spec.summary       = "Script to transform staged files using a formatting command"
+  spec.homepage      = "https://github.com/rogerluan/git_stage_formatter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rogerluan/git_stage_formatter"
+  spec.metadata["changelog_uri"] = "https://github.com/rogerluan/git_stage_formatter/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['git_stage_formatter']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '>= 2.0.0', '< 3.0.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/lib/git_stage_formatter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitStageFormatter
-  VERSION = "2.2.0"
+  VERSION = "3.0.0"
 end