mouseless@preview 0.4.0-preview.0 (new cask)

[croian]

Important: Do not tick a checkbox if you haven’t performed its action. Honesty is indispensable for a smooth review process.

In the following questions <cask> is the token of the cask you're submitting.

After making any changes to a cask, existing or new, verify:

• The submission is for a stable version or documented exception.
• brew audit --cask --online <cask> is error-free.
• brew style --fix <cask> reports no offenses.

Additionally, if adding a new cask:

• Named the cask according to the token reference.
• Checked the cask was not already refused (add your cask's name to the end of the search field).
• brew audit --cask --new <cask> worked successfully.
• HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask <cask> worked successfully.
• brew uninstall --cask <cask> worked successfully.

---

This is the preview channel for mouseless (an existing cask), and will point to the latest prerelease or stable build (whichever's more recent, of course).

I tried giving it the name mouseless@preview in the brew create command, but that got automatically changed to mouseless-at-preview, which strikes me as awkward, so I changed it to mouseless-preview. Please advise if any changes should be made.

[p-linnane]

This should be mouseless@preview per https://docs.brew.sh/Cask-Cookbook#casks-pinned-to-development-channels.

[croian]

@p-linnane thank you, updated

btw, i find it very confusing that the docs say to use @beta, etc (@preview), but then the install command only works with the hyphenated style string (and note that it says "No Cask with this name exists" when using the @):

homebrew-cask % HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask mouseless@preview   
Warning: Cask 'mouseless@preview' is unavailable: No Cask with this name exists.
==> Searching for similarly named casks...
==> Casks
mouseless-at-preview

To install mouseless-at-preview, run:
  brew install --cask mouseless-at-preview
homebrew-cask % HOMEBREW_NO_INSTALL_FROM_API=1 brew install --cask mouseless-at-preview
==> Downloading https://mouseless.click/mouseless-installer_v0.4.0-preview.0.dmg
Already downloaded: /Users/i/Library/Caches/Homebrew/downloads/154d152a22c1c9687fb6d80a651c1390740f435f3044298f4cd9a5093c64da59--mouseless-installer_v0.4.0-preview.0.dmg
==> Installing Cask mouseless-at-preview
==> Moving App 'Mouseless.app' to '/Applications/Mouseless.app'
🍺  mouseless-at-preview was successfully installed!

it makes it seem that users will have to do the same thing -- is this the case?

edit: additionally, the filename examples at the docs you linked have an @ (instead of a -at-) -- so is the output of brew create indeed incorrect?

[p-linnane]

No, the reason that's happening is because you already have mouseless-at-preview created. Here are some examples using @preview in the token: https://github.com/search?q=repo%3AHomebrew%2Fhomebrew-cask+%40preview&type=code

[croian]

Ok, I think I understand now. I updated the filename and token to mouseless@preview, and set the name field to mouseless preview channel. I appreciate the help.

Earnest feedback on the docs and the cli, take it as you will:

• I find it quite difficult to navigate the docs as I'm trying to pull together the different pieces of information needed to do a task, and to filter out signal from noise -- I think a persistent sidebar nav/overview would be very helpful. Clearer delineation between sections (more spacing, bigger headings), and centralized, high-level guides/summaries for specific tasks would help as well.
• I think it would also be helpful if the docs and/or CLI were clearer about why brew create --cask <url> --set-name x@y outputs a file / token of x-at-y (and why it's not what you want when you're pinning to a dev version), because once I did that I got set on a confusing path, and multiple places where @ is mentioned in the docs didn't help clear things up (here and here)
• It also creates confusion when the command output says No Cask with this name exists but it's not actually referring to the name field in the cask file.

[krehel]

Hey @croian - appreciate the feedback here. Valuable for us to capture!

Can you open an issue at https://github.com/Homebrew/brew/issues for your commentary on doc updates and what can improve the experience for contributors?

We would be more than happy to review any PR's for improvements to the docs (and is preferred over just an issue if you can!)

Cheers!