git_stage_formatter 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eef46e1e61e9298617a81667ae1d75dda336b9abae96da8d3f31f504e7a369e7
-  data.tar.gz: 315e59902076c09d46b87c57ddd580819860b4e5919085c0d232dd59ca7cf0ed
+  metadata.gz: 64a3dd9bf65c6bb93cb17974466d6a638bf68690e61a3ec9c113db4be63a6ac1
+  data.tar.gz: ded69b5da94227a628edb0c2f2341f960a340a3113fa8587b6be1f0405226346
 SHA512:
-  metadata.gz: 38b0689f0aa55e86523f8081ff222b48933613df2df159c6ac9a6bd7c27d865d438e7bc2d6e7e899299b0dcf15492c46fd8b5925164717978a7a4323d9f3ac95
-  data.tar.gz: cc11ea3ed725beaa56c164f882d19ac589dc0f4e6f3dfc3ba401a32af6d3600ef627be690611900bee82e1ba032bda49607e6686893a70039225ead123dfe139
+  metadata.gz: 5d6523769d0021592706c94ce8f9b47bce70abaa8b74d9c025c4bc33ff65803fd60381fc0e38882dcd1993ce8b3ae9d86e21cfbf0f7a046eb89b0bbfa8d495a0
+  data.tar.gz: 70492bc58d979e5105524e168353a82d2216f946cf1b776d774ff21fa22e9ab31277fd6e1c1438ee321d32e5df538ab7d87b067dc06b7dd64eb07c668fb4621e

data/.gitignore

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

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

@@ -217,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

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

@@ -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', '--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
@@ -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']
             )

data/git_stage_formatter.gemspec

@@ -23,7 +23,4 @@ Gem::Specification.new do |spec|
   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 = "3.0.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