when brew cat fails, suggest brew info --github

[g0t4]

When brew cat formula|cask fails, add suggestion to use brew info --github formula|cask instead. This gives a workaround for API users that don't have taps locally for homebrew/core and homebrew/cask.

This builds on changes from #14824 which addressed #14815

[MikeMcQuaid]

Suggested change

	$stderr.puts "The name may be wrong, or the tap hasn't been tapped."
	$stderr.puts "Consider using `brew info --github formula|cask [...]` instead."
	$stderr.puts "The name may be wrong, or the tap hasn't been tapped. Instead try:"
	$stderr.puts " brew info --github"

[MikeMcQuaid]

Looks good so far, thanks for the PR! A formatting suggestion.

[muescha]

Is it possiboe to add the cask Name - so that the suggested command is just read for copy paste?

[g0t4]

Yes, let me try adding that.

On Mon, Mar 6, 2023 at 11:06 AM Muescha ***@***.***> wrote: Is it possiboe to add the cask Name - so that the suggested command is just read for copy paste? — Reply to this email directly, view it on GitHub <#14902 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABL7XMIJJSSMGUJJ7VKCUDW2YKSNANCNFSM6AAAAAAVRFDKZ4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

-- Wes Higbee

[g0t4]

@MikeMcQuaid formatting change adopted
@muescha I added the formula/cask args

[muescha]

Great. Thx :)

It is possible to check if the option --cask is given and print it also?

[Rylan12]

I think in this case we shouldn't add an entire integration test just for this change. They're really slow and since this is just a messaging issue I think it's fine for it to be missed by tests.

Thanks for writing it, though!

[apainintheneck]

Good to go once this test is removed.

[MikeMcQuaid]

Thanks so much for your first contribution (hopefully of many)! Without people like you submitting PRs we couldn't run this project. You rock, @g0t4!

[g0t4]

My pleasure! About the test, I mostly wrote it to test drive the test fwk so I can handle the more advanced case of using the API to get the source. Thanks for the help too

On Tue, Mar 7, 2023 at 3:29 AM Mike McQuaid ***@***.***> wrote: Merged #14902 <#14902> into master. — Reply to this email directly, view it on GitHub <#14902 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABL7XIRZV5XYGOQ57TGA3TW235W5ANCNFSM6AAAAAAVRFDKZ4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

-- Wes Higbee

[muescha]

Great. Thx :)

It is possible to check if the option --cask is given and print it also?

$ brew cat docker
Error: docker's source doesn't exist on disk.
The name may be wrong, or the tap hasn't been tapped. Instead try:
  brew info --github docker

$ brew cat --cask docker
Error: docker's source doesn't exist on disk.
The name may be wrong, or the tap hasn't been tapped. Instead try:
  brew info --github docker

$ brew info --github docker
Warning: Treating docker as a formula. For the cask, use homebrew/cask/docker

opened https://github.com/Homebrew/homebrew-core/blob/HEAD/Formula/docker.rb

$ brew info --github --cask docker

opened https://github.com/Homebrew/homebrew-cask/blob/HEAD/Casks/docker.rb

[g0t4]

@muescha, yeah that was my fear with showing the args! darn edge cases

[g0t4]

@MikeMcQuaid hey I have another change as suggested by @muescha, should I open a new PR? it's right on top of the change you made to nuke the test, same branch in my repo. I've never reopened a merged+closed PR before, so I'm not sure if that's doable?

@muescha if you wanna give feedback on it, here it is... it was a quick hack just to test it out :)

master...g0t4:brew:cat_mention_brew_info_github

[g0t4]

@muescha oh and I just have to ask... will there be flame wars over suggesting --formula vs --formulae and --cask vs --casks ;)

[muescha]

the PR is already merged - so you have to create a new PR

[muescha]

but i see at your link there is a green button to create a new pull request

the man page says

     --formula
              Treat all named arguments as formulae.

       --cask Treat all named arguments as casks.

so there is no --formulae and no --casks

[g0t4]

@muescha looks like man pages are out of date!

$ brew cat --help

Usage: brew cat [--formula] [--cask] formula|cask [...]

Display the source of a formula or cask.

      --formula, --formulae        Treat all named arguments as formulae.
      --cask, --casks              Treat all named arguments as casks.
  -d, --debug                      Display any debugging information.
  -q, --quiet                      Make some output more quiet.
  -v, --verbose                    Make some output more verbose.
  -h, --help                       Show this message.

Completions also don't have --casks/--formulae, which IMO is a good thing to avoid wondering if the arg is different when it's just an alias!