Improve CLI UX by more providing feedback when an unrecognized command is used (#8)

Author: Alex Evanczuk

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    code_ownership (1.25.0)
+    code_ownership (1.26.0)
       bigrails-teams
       parse_packwerk
       sorbet-runtime

code_ownership.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "code_ownership"
-  spec.version       = '1.25.0'
+  spec.version       = '1.26.0'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['[email protected]']
   spec.summary       = 'A gem to help engineering teams declare ownership of code'

lib/code_ownership/cli.rb

@@ -11,7 +11,19 @@ def self.run!(argv)
         validate!(argv)
       elsif command == 'for_file'
         for_file(argv)
+      elsif [nil, "help"].include?(command)
+        puts <<~USAGE
+          Usage: bin/codeownership <subcommand>
+
+          Subcommands:
+            validate - run all validations
+            for_file - find code ownership for a single file
+            help  - display help information about code_ownership
+        USAGE
+      else
+        puts "'#{command}' is not a code_ownership command. See `bin/codeownership help`."
       end
+
     end
 
     def self.validate!(argv)

spec/lib/code_ownership/cli_spec.rb

@@ -103,4 +103,30 @@
       end
     end
   end
+
+  describe 'using unknown command' do
+    let(:argv) { ['some_command'] }
+
+    it 'outputs help text' do
+      expect(CodeOwnership::Cli).to receive(:puts).with("'some_command' is not a code_ownership command. See `bin/codeownership help`.")
+      subject
+    end
+  end
+
+  describe 'passing in no command' do
+    let(:argv) { [] }
+
+    it 'outputs help text' do
+      expected = <<~EXPECTED
+      Usage: bin/codeownership <subcommand>
+
+      Subcommands:
+        validate - run all validations
+        for_file - find code ownership for a single file
+        help  - display help information about code_ownership
+      EXPECTED
+      expect(CodeOwnership::Cli).to receive(:puts).with(expected)
+      subject
+    end
+  end
 end