This document summarizes revisions to the Cask Domain-Specific Language (DSL).
These are deltas from the pre-existing (unversioned) conventions to the Cask DSL 1.0 specification.
- This Document Is Incomplete
- Removals (1.0)
- Additions (1.0)
- Renames (1.0)
- Header Line (1.0)
- All Supported Stanzas (1.0)
This document still being written. It is not yet a complete reference. This notice will be removed for the final form.
Stub!
appcastartifactdepends_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
gpginstaller :scriptlicensesuitestage_onlytagsuninstall :rmdiruninstall :trash- stub - currently just a synonym for
uninstall :delete
- stub - currently just a synonym for
zap
| 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 |
install |
pkg |
link |
app (or sometimes suite or artifact) |
nested_container |
container :nested => |
uninstall :files |
uninstall :delete |
version 'latest' |
version :latest |
manual_installer(path) (within caveats) |
installer :manual |
destination_path |
staged_path |
Stub!
The header line was changed from the form
class MyApp < Caskto
cask :v1 => 'my-app' doLegacy 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.