Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-10 15:14:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Tidy --help output slightly

Browse source 
Give `exec` a short description in the main help output. Hide the option to disable core plugins.

Signed-off-by: James Stocks <jstocks@chef.io>
This commit is contained in:
James Stocks 2020-09-18 10:41:19 +01:00
parent 7576ad8ff5
commit db5f6a1615
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/inspec/cli.rb
View file

@ -48,7 +48,8 @@ class Inspec::InspecCLI < Inspec::BaseCLI
desc: "Allow or disable user interaction"
class_option :disable_core_plugins, type: :string, banner: "", # Actually a boolean, but this suppresses the creation of a --no-disable...
desc: "Disable loading all plugins that are shipped in the lib/plugins directory of InSpec. Useful in development."
desc: "Disable loading all plugins that are shipped in the lib/plugins directory of InSpec. Useful in development.",
hide: true
class_option :disable_user_plugins, type: :string, banner: "",
desc: "Disable loading all plugins that the user installed."
@ -194,7 +195,8 @@ class Inspec::InspecCLI < Inspec::BaseCLI
pretty_handle_exception(e)
end
desc "exec LOCATIONS", <<~EOT
desc "exec LOCATIONS", "Run all tests at LOCATIONS."
long_desc <<~EOT
Run all test files at the specified LOCATIONS.
Loads the given profile(s) and fetches their dependencies if needed. Then

6
test/functional/plugins_test.rb
View file

@ -177,11 +177,9 @@ end
# Plugin Disable Messaging
#=========================================================================================#
describe "disable plugin usage message integration" do
it "mentions the --disable-{user,core}-plugins options" do
it "mentions the --disable-user-plugins option" do
outcome = inspec("help")
["--disable-user-plugins", "--disable-core-plugins"].each do |option|
_(outcome.stdout).must_include(option)
end
_(outcome.stdout).must_include("--disable-user-plugins")
end
end