dry-cli 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bb38a55577b2607724ceaafe32979ca39b83b62ece8d5e734f522646042d2f5
-  data.tar.gz: 05e3fe644ca5fceb2bd3dc740453faf8aab28faaf7ad5ae9ab39a23474f7f611
+  metadata.gz: 816b3ffdbf5a84ad4ce91ff6be0bba9424141a7b28b880accb087ba65b63e36d
+  data.tar.gz: 6ca3a54ff35dcb634acf68ff6472ddc8737cc15f99d6f7f860ac89e491759cd4
 SHA512:
-  metadata.gz: 97ff398081901a642d1d8d898a50eec46e33103defff2e4c77f11a0e5150dcb79fc7e568cbeaaeaa7e6af9f0e05835b265a2ceb7fda144f4983b8dfc27363728
-  data.tar.gz: 39b43443b842724a7096a909bba93dd93ceda1c470a2cfc2ec9ac9e02f2aee0b449f2dd6c2b7bf9c0c92485ad404a14ba1a352518d5070366535bbc19d5cb789
+  metadata.gz: e1b289e4571b3b658ff402f1c8dd2fa8c7746fc3a17293f2a3316961622adc1570c76b82dfbcf4c74c6510f1994952928d64eb56e99284acfae797f6adeb8037
+  data.tar.gz: 4739d57ca298e1c85afcd5d0c499a56ca04db8e802d4c84be905a674e884599d4b2dbedca66927d9ed9a0467a5b1468c063bd57b25109c6a7e1c69068b113b59

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
+## 1.2.0 2024-10-15
+
+
+### Added
+
+- Added `:hidden` option to register commands that should not be shown in the help output. (@benoittgt in #137)
+- Provide suggestions when there is a typo in a command name. (@benoittgt in #138)
+
+
+[Compare v1.1.0...v1.2.0](https://github.com/dry-rb/dry-cli/compare/v1.1.0...v1.2.0)
+
 ## 1.1.0 2024-07-14
 
 

data/lib/dry/cli/command_registry.rb

@@ -18,7 +18,7 @@ module Dry
 
       # @since 0.1.0
       # @api private
-      def set(name, command, aliases)
+      def set(name, command, aliases, hidden)
         @_mutex.synchronize do
           node = @root
           name.split(/[[:space:]]/).each do |token|
@@ -26,6 +26,7 @@ module Dry
           end
 
           node.aliases!(aliases)
+          node.hidden!(hidden)
           if command
             node.leaf!(command)
             node.subcommands!(command)
@@ -91,6 +92,10 @@ module Dry
         # @api private
         attr_reader :aliases
 
+        # @since 1.1.1
+        # @api private
+        attr_reader :hidden
+
         # @since 0.1.0
         # @api private
         attr_reader :command
@@ -109,6 +114,7 @@ module Dry
           @parent   = parent
           @children = {}
           @aliases  = {}
+          @hidden   = hidden
           @command  = nil
 
           @before_callbacks = Chain.new
@@ -154,6 +160,12 @@ module Dry
           end
         end
 
+        # @since 1.1.1
+        # @api private
+        def hidden!(hidden)
+          @hidden = hidden
+        end
+
         # @since 0.1.0
         # @api private
         def leaf?

data/lib/dry/cli/registry.rb

@@ -75,11 +75,11 @@ module Dry
       #       end
       #     end
       #   end
-      def register(name, command = nil, aliases: [], &block)
-        @commands.set(name, command, aliases)
+      def register(name, command = nil, aliases: [], hidden: false, &block)
+        @commands.set(name, command, aliases, hidden)
 
         if block_given?
-          prefix = Prefix.new(@commands, name, aliases)
+          prefix = Prefix.new(@commands, name, aliases, hidden)
           if block.arity.zero?
             prefix.instance_eval(&block)
           else
@@ -308,19 +308,19 @@ module Dry
       class Prefix
         # @since 0.1.0
         # @api private
-        def initialize(registry, prefix, aliases)
+        def initialize(registry, prefix, aliases, hidden)
           @registry = registry
           @prefix   = prefix
 
-          registry.set(prefix, nil, aliases)
+          registry.set(prefix, nil, aliases, hidden)
         end
 
         # @since 0.1.0
         #
         # @see Dry::CLI::Registry#register
-        def register(name, command, aliases: [])
+        def register(name, command, aliases: [], hidden: false)
           command_name = "#{prefix} #{name}"
-          registry.set(command_name, command, aliases)
+          registry.set(command_name, command, aliases, hidden)
         end
 
         private

data/lib/dry/cli/spell_checker.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry/cli/program_name"
+require "did_you_mean"
+
+module Dry
+  class CLI
+    # Command(s) usage
+    #
+    # @since 1.1.1
+    # @api private
+    module SpellChecker
+      # @since 1.1.1
+      # @api private
+      def self.call(result, arguments)
+        commands = result.children.keys
+        cmd = cmd_to_spell(arguments, result.names)
+
+        suggestions = DidYouMean::SpellChecker.new(dictionary: commands).correct(cmd.first)
+        if suggestions.any?
+          "I don't know how to '#{cmd.join(" ")}'. Did you mean: '#{suggestions.first}' ?"
+        end
+      end
+
+      # @since 1.1.1
+      # @api private
+      def self.cmd_to_spell(arguments, result_names)
+        arguments - result_names
+      end
+
+      # @since 1.1.1
+      # @api private
+      def self.ignore?(cmd)
+        cmd.empty? || cmd.first.start_with?("-")
+      end
+    end
+  end
+end

data/lib/dry/cli/usage.rb

@@ -21,9 +21,11 @@ module Dry
         max_length, commands = commands_and_arguments(result)
 
         commands.map do |banner, node|
+          next if node.hidden
+
           usage = description(node.command) if node.leaf?
           "#{justify(banner, max_length, usage)}#{usage}"
-        end.unshift(header).join("\n")
+        end.compact.unshift(header).join("\n")
       end
 
       # @since 0.1.0

data/lib/dry/cli/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class CLI
     # @since 0.1.0
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/dry/cli.rb

@@ -14,6 +14,7 @@ module Dry
     require "dry/cli/registry"
     require "dry/cli/parser"
     require "dry/cli/usage"
+    require "dry/cli/spell_checker"
     require "dry/cli/banner"
     require "dry/cli/inflector"
 
@@ -108,7 +109,7 @@ module Dry
     # @api private
     def perform_registry(arguments)
       result = registry.get(arguments)
-      return usage(result) unless result.found?
+      return spell_checker(result, arguments) unless result.found?
 
       command, args = parse(result.command, result.arguments, result.names)
 
@@ -161,9 +162,11 @@ module Dry
       exit(1)
     end
 
-    # @since 0.1.0
-    # @api private
-    def usage(result)
+    # @since 1.1.1
+    def spell_checker(result, arguments)
+      spell_checker = SpellChecker.call(result, arguments)
+      err.puts spell_checker if spell_checker
+      puts
       err.puts Usage.call(result)
       exit(1)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Luca Guidi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-14 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,7 @@ files:
 - lib/dry/cli/parser.rb
 - lib/dry/cli/program_name.rb
 - lib/dry/cli/registry.rb
+- lib/dry/cli/spell_checker.rb
 - lib/dry/cli/usage.rb
 - lib/dry/cli/version.rb
 homepage: https://dry-rb.org/gems/dry-cli
@@ -118,7 +119,7 @@ metadata:
   changelog_uri: https://github.com/dry-rb/dry-cli/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-cli
   bug_tracker_uri: https://github.com/dry-rb/dry-cli/issues
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Common framework to build command line interfaces with Ruby
 test_files: []