Adds brew docs
to close #13834
This commit is contained in:
parent
f041a59af9
commit
ac9a96874e
24
Library/Homebrew/cmd/docs.rb
Normal file
24
Library/Homebrew/cmd/docs.rb
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
# typed: true
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
require "cli/parser"
|
||||||
|
|
||||||
|
module Homebrew
|
||||||
|
extend T::Sig
|
||||||
|
|
||||||
|
module_function
|
||||||
|
|
||||||
|
sig { returns(CLI::Parser) }
|
||||||
|
def docs_args
|
||||||
|
Homebrew::CLI::Parser.new do
|
||||||
|
description <<~EOS
|
||||||
|
Open Homebrew's docs (https://docs.brew.sh) in a browser.
|
||||||
|
EOS
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
sig { void }
|
||||||
|
def docs
|
||||||
|
exec_browser HOMEBREW_DOCS_WWW
|
||||||
|
end
|
||||||
|
end
|
@ -45,6 +45,7 @@ HOMEBREW_REQUIRED_RUBY_VERSION = ENV.fetch("HOMEBREW_REQUIRED_RUBY_VERSION").fre
|
|||||||
HOMEBREW_PRODUCT = ENV.fetch("HOMEBREW_PRODUCT").freeze
|
HOMEBREW_PRODUCT = ENV.fetch("HOMEBREW_PRODUCT").freeze
|
||||||
HOMEBREW_VERSION = ENV.fetch("HOMEBREW_VERSION").freeze
|
HOMEBREW_VERSION = ENV.fetch("HOMEBREW_VERSION").freeze
|
||||||
HOMEBREW_WWW = "https://brew.sh"
|
HOMEBREW_WWW = "https://brew.sh"
|
||||||
|
HOMEBREW_DOCS_WWW = "https://docs.brew.sh"
|
||||||
HOMEBREW_SYSTEM = ENV.fetch("HOMEBREW_SYSTEM").freeze
|
HOMEBREW_SYSTEM = ENV.fetch("HOMEBREW_SYSTEM").freeze
|
||||||
HOMEBREW_PROCESSOR = ENV.fetch("HOMEBREW_PROCESSOR").freeze
|
HOMEBREW_PROCESSOR = ENV.fetch("HOMEBREW_PROCESSOR").freeze
|
||||||
|
|
||||||
|
11
Library/Homebrew/test/cmd/docs_spec.rb
Normal file
11
Library/Homebrew/test/cmd/docs_spec.rb
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
# typed: false
|
||||||
|
# frozen_string_literal: true
|
||||||
|
|
||||||
|
describe "brew docs" do
|
||||||
|
it "opens the docs page", :integration_test do
|
||||||
|
expect { brew "docs", "HOMEBREW_BROWSER" => "echo" }
|
||||||
|
.to output("https://docs.brew.sh\n").to_stdout
|
||||||
|
.and not_to_output.to_stderr
|
||||||
|
.and be_a_success
|
||||||
|
end
|
||||||
|
end
|
Loading…
x
Reference in New Issue
Block a user