Add `inspec env` command to configure shell tab-completion #896

stevendanna · 2016-08-09T11:12:19Z

This adds a new subcommand:

inspec env [SHELL]

which outputs a shell-appropriate completion script that the user can
source into their shell:

eval "$(inspec env SHELL)"

Currently, we provide completions for ZSH and Bash. The completion
scripts are generated from the data Thor collects.

If the user doesn't provide SHELL we attempt to detect what the user's
shell may be using a number of methods.

Fixes #607

Signed-off-by: Steven Danna steve@chef.io

chris-rock · 2016-08-09T16:56:25Z

lib/inspec/shell_detector.rb

+
+    def detect
+      # Most of our detection code assumes a unix-like environment
+      return nil if (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)


May it make sense to output a warning? Otherwise the user may be confused that nothing has been executed?

chris-rock · 2016-08-09T17:01:11Z

@stevendanna great work. Bash completion works like a charm. I've some troubles with zsh and get the following errors:

eval "$(inspec env zsh)"
zsh: parse error near `>'

My generated content is available here: https://gist.github.com/chris-rock/a30592b0b82d13136772c10162dc5752

chris-rock · 2016-08-09T17:06:10Z

lib/inspec/env_printer.rb

+      if @detected
+        $stderr.puts '# Unable to automatically detect shell and no shell was provided.'
+      end
+      $stderr.puts <<EOF


chris-rock · 2016-08-09T17:21:14Z

Awesome implementation @stevendanna LGTM once the zsh is working

stevendanna · 2016-08-09T20:14:12Z

@chris-rock I think ZSH should be working now. The issue was we weren't escaping the description text and you had plugins that had commands with ' in their description. Now we use shellwords to escape any special characters in the description. Let me know if it works for you.

chris-rock · 2016-08-09T20:43:02Z

@stevendanna works like a charm now!

This adds a new subcommand: inspec env [SHELL] which outputs a shell-appropriate completion script that the user can source into their shell: eval "$(inspec env SHELL)" Currently, we provide completions for ZSH and Bash. The completion scripts are generated from the data Thor collects. If the user doesn't provide SHELL we attempt to detect what the user's shell may be using a number of methods. Signed-off-by: Steven Danna <steve@chef.io>

stevendanna · 2016-08-10T09:50:52Z

Merging this despite failing tests since TravisCI seems to be having an incident of some sort.