cask_language_deltas.md

Cask Language Deltas

This document summarizes revisions to the Cask Domain-Specific Language (DSL).

• This Document Is Incomplete
• Cask DSL 1.0
• References

This Document Is Incomplete

This document is still being written. It is not yet a complete reference. This notice will be removed for the final form.

Cask DSL 1.0

These are deltas from the pre-existing (unversioned) conventions to the Cask DSL 1.0 specification.

• Header Line (1.0)
• New Forms (1.0)
• Renamed Forms (1.0)
• All Supported Stanzas (1.0)
• Other Supported Non-stanza Methods (1.0)
• Caveats Mini-DSL (1.0)

Header Line (1.0)

The header line was changed from the form

class MyApp < Cask

to

cask :v1 => 'my-app' do

Legacy rules for mapping Cask filenames to header class names are no longer needed. The name 'my-app' in the header corresponds directly to the filename my-app.rb.

The term :v1 identifies the DSL version (currently 1.0), and defines the features which are available for the current Cask.

New Forms (1.0)

• appcast
• artifact
• depends_on :cask
  • stub - not yet functional
• depends_on :macos
  • stub - not yet functional
• depends_on :arch
  • stub - not yet functional
• depends_on :x11
  • stub - not yet functional
• depends_on :java
  • stub - not yet functional
• conflicts_with
  • stub - not yet functional
• gpg stub: not yet functional.
• installer :script
• license
• stage_only
  • replaced undocumented caskroom_only
• suite
• tags
• uninstall :rmdir
• uninstall :trash
  • stub - currently just a synonym for uninstall :delete
• zap

Renamed Forms (1.0)

old form	new form
after_install	postflight
after_uninstall	uninstall_postflight
before_install	preflight
before_uninstall	uninstall_preflight
container_type	container :type
depends_on_formula	depends_on :formula
destination_path	staged_path
install	pkg
link	app (or sometimes suite or artifact)
manual_installer(path) (within caveats)	installer :manual
nested_container	container :nested =>
uninstall :files	uninstall :delete
version 'latest'	version :latest

All Supported Stanzas (1.0)

• app
• appcast
• artifact
• binary
• caveats
• colorpicker
• conflicts_with
• container
• depends_on
• font
• gpg stub: not yet functional.
• homepage
• input_method
• installer
• internet_plugin
• license
• pkg
• postflight
• preflight
• prefpane
• qlplugin
• screen_saver
• service
• sha256
• stage_only
• suite
• tags
• uninstall_postflight
• uninstall_preflight
• uninstall
• url
• version
• widget
• zap

Other Supported Non-stanza Methods (1.0)

For use in eg interpolation:

• caskroom_path
• staged_path
• title

Caveats Mini-DSL (1.0)

• arch_only(list)
• assistive_devices
• files_in_usr_local
• logout
• os_version_only(list)
• path_environment_variable(path)
• reboot
• x11_required
• zsh_path_helper(path)

References

• DSL 1.0 transition notice
• DSL 1.0 roadmap
• DSL 1.1 roadmap
• DSL 2.0 roadmap
• brew cask upgrade roadmap
• Full specification

<3 THANK YOU TO ALL CONTRIBUTORS! <3