git_stage_formatter 2.2.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e24f5f48a24491053f2e2220ce055df6f61c6207a750f5a8ff6098afbde4120a
-  data.tar.gz: 54553233ebdb102c78ab79d8a660c12f8df10647f3cfb65c22397516d8f0b965
+  metadata.gz: 64a3dd9bf65c6bb93cb17974466d6a638bf68690e61a3ec9c113db4be63a6ac1
+  data.tar.gz: ded69b5da94227a628edb0c2f2341f960a340a3113fa8587b6be1f0405226346
 SHA512:
-  metadata.gz: 20911e08c4169554122387169899c2d93f9b0be2ef7d305370c059dba9be6ab88a8553efdbf0fbb74598a31ea62cc7945a04dcb416379fb7abef8f1d677700f4
-  data.tar.gz: d86c46ed60800b49fd8ee4132226e97483a1fb15060d08642984d55fc23096f2d8147ea04a835763d48ef8c25ff1e05d7afd87472f6a8a745039b41872bc0b9c
+  metadata.gz: 5d6523769d0021592706c94ce8f9b47bce70abaa8b74d9c025c4bc33ff65803fd60381fc0e38882dcd1993ce8b3ae9d86e21cfbf0f7a046eb89b0bbfa8d495a0
+  data.tar.gz: 70492bc58d979e5105524e168353a82d2216f946cf1b776d774ff21fa22e9ab31277fd6e1c1438ee321d32e5df538ab7d87b067dc06b7dd64eb07c668fb4621e

data/.gitignore

@@ -4,7 +4,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/Gemfile

@@ -4,3 +4,7 @@ source "https://rubygems.org"
 
 # Gem dependencies specified in git_stage_formatter.gemspec
 gemspec
+
+gem "bundler", "~> 2"
+gem "rake"
+gem "tty-prompt"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    git_stage_formatter (3.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (13.0.6)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  bundler (~> 2)
+  git_stage_formatter!
+  rake
+  tty-prompt
+
+BUNDLED WITH
+   2.4.18

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
@@ -192,3 +217,15 @@ Some more comparisons:
 [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
+
+# Development
+
+To bump the lib's version, run `bundle exec rake bump[1.2.3]` (replacing the value with the desired version).
+
+To release a new version, update the version number in `version.rb` (likely done via `rake bump` above), and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+# Contributing
+
+If you spot something wrong, missing, or if you'd like to propose improvements to this project, please open an Issue or a Pull Request with your ideas and I promise to get back to you within 24 hours! 😇
+
+For a list of issues worth tackling check out: https://github.com/rogerluan/git_stage_formatter/issues

data/Rakefile

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "tty-prompt"
+
+task default: %i[]
+
+desc "Sets lib version to the semantic version given, and push it to remote."
+task :bump, [:v] do |_t, args|
+  version = args[:v] || raise("A version is required. Pass it like `rake bump[1.2.3]`")
+  next unless TTY::Prompt.new.yes?("Would you like to set the new version of the app to be '#{version}'?")
+
+  version_filename = Dir.glob("lib/*/version.rb").first
+  version_file_contents = File.read(version_filename)
+  new_version_file_contents = version_file_contents.gsub(/VERSION = "(?:.*)"/, "VERSION = \"#{version}\"")
+  File.open(version_filename, "w") { |file| file.puts new_version_file_contents }
+  sh("bundle install")
+  sh("git add #{version_filename} Gemfile.lock")
+  sh("git commit -m 'Bump app version to v#{version}.'")
+  sh("git push origin")
+end

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)
@@ -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',
@@ -48,9 +48,12 @@ 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):
+            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))
@@ -58,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:
@@ -87,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
@@ -142,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
@@ -228,12 +234,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',
@@ -251,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='+',
@@ -263,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']
             )

data/git_stage_formatter.gemspec

@@ -0,0 +1,26 @@
+# 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"]
+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.1"
 end

data/lib/git_stage_formatter.rb

@@ -2,7 +2,8 @@ require_relative "git_stage_formatter/version"
 
 module GitStageFormatter
   def self.run(args)
-    args = args.join(' ')
+    # Wrap each argument in quotes to handle spaces in paths
+    args = args.map { |arg| "\"#{arg}\"" }.join(' ')
     script_path = File.expand_path('../git-format-staged', File.dirname(__FILE__))
     exec("#{script_path} #{args}")
   end