omg-thor-ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6ff852a38ac2fb14b24322624a09954d0f17a83f5033f8a34b4aec053e7bd49
+  data.tar.gz: 7e9502a446a5c984a8af524f10f5c1c415581d921ab55fab7d5367489977dca5
+SHA512:
+  metadata.gz: e9be6bbd4492860365bfb8bff70e1520a5affc1004cbff0044808f4517e9129c3d2379518b9dd3bafe832e479cc5982234c3529baf733cf4da6760ee23044408
+  data.tar.gz: a4730ed0c378b160668884083ec7d452386ae0b908d66a14fd43cc151c9cb613e2ca231217c0a7ef1dcd2886e855c54dbef279aeaf700880675f7d3ca94c0c56

data/README.md

@@ -0,0 +1,37 @@
+# Thor extension
+
+[Matt Brictson](https://github.com/mattbrictson) had the same complaints I did about [Thor](https://github.com/rails/thor). Well, he went and fixed them all, I put them into a gem and now use it in many of my Thor CLIs.
+
+## Original source
+
+https://github.com/mattbrictson/gem/blob/main/lib/example/thor_ext.rb
+
+## What it does
+
+Overwrites a few Thor methods so that it behaves more like a typical CLI:
+
+- Accepts `-h` or `--help` to show help
+- Treats unrecognized options as errors instead of ignoring them
+- Prints error to `stderr` in red with no stacktrace
+- Prints full stacktrace when setting `VERBOSE` environment variable
+- Exists with a non-zero status on error
+
+## Installation
+
+```sh
+gem i thor-ext
+```
+
+```ruby
+gem 'thor-ext'
+```
+
+## Usage
+
+In your Thor CLI:
+
+```ruby
+class SuperAwesomeCli < Thor
+  extend ThorExt::Start
+end
+```

data/lib/thor_ext.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module ThorExt
+  VERSION = '0.1.0'
+
+  module Start
+    def self.extended(base)
+      super
+      base.check_unknown_options!
+    end
+
+    def start(given_args = ARGV, config = {})
+      config[:shell] ||= ::Thor::Base.shell.new
+      handle_help_switches(given_args) do |args|
+        dispatch(nil, args, nil, config)
+      end
+    rescue StandardError => e
+      handle_exception_on_start(e, config)
+    end
+
+    private
+
+    def handle_help_switches(given_args)
+      yield(given_args.dup)
+    rescue ::Thor::UnknownArgumentError => e
+      retry_with_args = []
+
+      if given_args.first == 'help'
+        retry_with_args = ['help'] if given_args.length > 1
+      elsif (e.unknown & %w[-h --help]).any?
+        retry_with_args = ['help', (given_args - e.unknown).first]
+      end
+      raise if retry_with_args.none?
+
+      yield(retry_with_args)
+    end
+
+    def handle_exception_on_start(error, config)
+      return if error.is_a?(Errno::EPIPE)
+      raise if ENV['VERBOSE'] || !config.fetch(:exit_on_failure, true)
+
+      message = error.full_message.to_s
+      message.prepend("[#{error.class}] ") if message.empty? || !error.is_a?(::Thor::Error)
+
+      config[:shell]&.say_error(message, :red)
+      exit(false)
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: omg-thor-ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthew Greenfield
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-09 00:00:00.000000000 Z
+dependencies: []
+description: 'Original source: https://github.com/mattbrictson/gem/blob/main/lib/example/thor_ext.rb'
+email:
+- mattgreenfield1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/thor_ext.rb
+homepage: https://github.com/omgreenfield/thor-ext
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/omgreenfield/thor-ext
+  source_code_uri: https://github.com/omgreenfield/thor-ext
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: Packages Matt Brictson's extension to make Thor behave like a typical CLI
+test_files: []