Skip to content

Latest commit

 

History

History
148 lines (90 loc) · 8.56 KB

token_reference.md

File metadata and controls

148 lines (90 loc) · 8.56 KB
Raw

Cask Token Reference

This document describes the algorithm implemented in the generate_cask_token script, and covers detailed rules and exceptions which are not needed in most cases.

Purpose

The purpose of these stringent conventions is to:

  • Unambiguously boil down the name of the software into a unique identifier
  • Minimize renaming events
  • Prevent duplicate submissions

The token itself should be:

  • Suitable for use as a filename
  • Mnemonic

Details of software names and brands will inevitably be lost in the conversion to a minimal token. To capture the vendor’s full name for a distribution, use the name within a Cask. name accepts an unrestricted UTF-8 string.

Finding the Simplified Name of the Vendor’s Distribution

Simplified Names of Apps

  • Start with the exact name of the Application bundle as it appears on disk, such as Google Chrome.app.

  • If the name uses letters outside A-Z, convert it to ASCII as described in Converting to ASCII.

  • Remove .app from the end.

  • Remove from the end: the string “app”, if the vendor styles the name like “Software App.app”. Exception: when “app” is an inseparable part of the name, without which the name would be inherently nonsensical, as in rcdefaultapp.rb.

  • Remove from the end: version numbers or incremental release designations such as “alpha”, “beta”, or “release candidate”. Strings which distinguish different capabilities or codebases such as “Community Edition” are currently accepted. Exception: when a number is not an incremental release counter, but a differentiator for a different product from a different vendor, as in pgadmin3.rb.

  • If the version number is arranged to occur in the middle of the App name, it should also be removed. Example: IntelliJ IDEA 13 CE.app.

  • Remove from the end: “Launcher”, “Quick Launcher”.

  • Remove from the end: strings such as “Desktop”, “for Desktop”.

  • Remove from the end: strings such as “Mac”, “for Mac”, “for OS X”, “macOS”, “for macOS”. These terms are generally added to ported software such as “MAME OS X.app”. Exception: when the software is not a port, and “Mac” is an inseparable part of the name, without which the name would be inherently nonsensical, as in PlayOnMac.app.

  • Remove from the end: hardware designations such as “for x86”, “32-bit”, “ppc”.

  • Remove from the end: software framework names such as “Cocoa”, “Qt”, “Gtk”, “Wx”, “Java”, “Oracle JVM”, etc. Exception: the framework is the product being Casked, as in java.rb.

  • Remove from the end: localization strings such as “en-US”.

  • If the result of that process is a generic term, such as “Macintosh Installer”, try prepending the name of the vendor or developer, followed by a hyphen. If that doesn’t work, then just create the best name you can, based on the vendor’s web page.

  • If the result conflicts with the name of an existing Cask, make yours unique by prepending the name of the vendor or developer, followed by a hyphen. Example: unison.rb and panic-unison.rb.

  • Inevitably, there are a small number of exceptions not covered by the rules. Don’t hesitate to contact the maintainers if you have a problem.

Converting to ASCII

  • If the vendor provides an English localization string, that is preferred. Here are the places it may be found, in order of preference:

    • CFBundleDisplayName in the main Info.plist file of the app bundle
    • CFBundleName in the main Info.plist file of the app bundle
    • CFBundleDisplayName in InfoPlist.strings of an en.lproj localization directory
    • CFBundleName in InfoPlist.strings of an en.lproj localization directory
    • CFBundleDisplayName in InfoPlist.strings of an English.lproj localization directory
    • CFBundleName in InfoPlist.strings of an English.lproj localization directory

  • When there is no vendor localization string, romanize the name by transliteration or decomposition.

  • As a last resort, translate the name of the app bundle into English.

Simplified Names of pkg-based Installers

  • The Simplified Name of a pkg may be more tricky to determine than that of an App. If a pkg installs an App, then use that App name with the rules above. If not, just create the best name you can, based on the vendor’s web page.

Simplified Names of non-App Software

  • Currently, rules for generating a token are not well-defined for Preference Panes, QuickLook plugins, and several other types of software installable by Homebrew-Cask. Just create the best name you can, based on the filename on disk or the vendor’s web page. Watch out for duplicates.

    Non-app tokens should become more standardized in the future.

Converting the Simplified Name To a Token

The token is the primary identifier for a package in our project. It’s the unique string users refer to when operating on the Cask.

To convert the App’s Simplified Name (above) to a token:

  • Convert all letters to lower case.
  • Expand the + symbol into a separated English word: -plus-.
  • Expand the @ symbol into a separated English word: -at-.
  • Spaces become hyphens.
  • Underscores become hyphens.
  • Middots/Interpuncts become hyphens.
  • Hyphens stay hyphens.
  • Digits stay digits.
  • Delete any character which is not alphanumeric or a hyphen.
  • Collapse a series of multiple hyphens into one hyphen.
  • Delete a leading or trailing hyphen.

We avoid defining Cask tokens in the repository which differ only by the placement of hyphens. Prepend the vendor name if needed to disambiguate the token.

Cask Filenames

Casks are stored in a Ruby file named after the token, with the file extension .rb.

Cask Headers

The token is also given in the header line for each Cask.

Cask Token Examples

These illustrate most of the rules for generating a token:

App Name on Disk Simplified App Name Cask Token Filename
Audio Hijack Pro.app Audio Hijack Pro audio-hijack-pro audio-hijack-pro.rb
VLC.app VLC vlc vlc.rb
BetterTouchTool.app BetterTouchTool bettertouchtool bettertouchtool.rb
LPK25 Editor.app LPK25 Editor lpk25-editor lpk25-editor.rb
Sublime Text 2.app Sublime Text sublime-text sublime-text.rb

Tap Specific Cask Token Examples

Cask taps have naming conventions specific to each tap.

Homebrew/cask-versions

Homebrew/cask-fonts

Homebrew/cask-drivers

Homebrew/cask-eid

Token Overlap

With another Cask

When the token for a new Cask would otherwise conflict with the token of an already existing Cask, the nature of that overlap dictates the token (for possibly both Casks). See Forks and Apps with Conflicting Names for information on how to proceed.

With a formula

If a Homebrew formula and a Homebrew-Cask cask both exist with the same token and they both refer to the same app — respectively a CLI and a GUI — and the GUI app is simply a wrapper of the CLI tool but has been decided to provide enough value to warrant the inclusion of both the formula and the cask, the cask will have the -app suffix. This is the only instance where an -app suffix is allowed, precisely so the “why” is clear when you know the rule.