mirror of
https://github.com/wavetermdev/homebrew-cask.git
synced 2026-08-05 13:43:24 -07:00
Merge pull request #7567 from rolandwalker/fill_in_deltas
fill in `cask_language_deltas.md`
This commit is contained in:
ndr
+119
-67
@@ -2,84 +2,28 @@
|
||||
|
||||
This document summarizes revisions to the Cask Domain-Specific Language (DSL).
|
||||
|
||||
* [This Document Is Incomplete](#this-document-is-incomplete)
|
||||
* [Cask DSL 1.0](#cask-dsl-10)
|
||||
* [References](#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.
|
||||
|
||||
* [This Document Is Incomplete](#this-document-is-incomplete)
|
||||
* [Removals (1.0)](#removals-10)
|
||||
* [Additions (1.0)](#additions-10)
|
||||
* [Renames (1.0)](#renames-10)
|
||||
* [Header Line (1.0)](#header-line-10)
|
||||
* [New Forms (1.0)](#new-forms-10)
|
||||
* [Renamed Forms (1.0)](#renamed-forms-10)
|
||||
* [All Supported Stanzas (1.0)](#all-supported-stanzas-10)
|
||||
|
||||
|
||||
## This Document Is Incomplete
|
||||
|
||||
**This document still being written. It is not yet a complete reference.
|
||||
This notice will be removed for the final form.**
|
||||
|
||||
|
||||
## Removals (1.0)
|
||||
|
||||
**Stub!**
|
||||
|
||||
|
||||
## Additions (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`
|
||||
* `installer :script`
|
||||
* `license`
|
||||
* `suite`
|
||||
* `stage_only`
|
||||
* `tags`
|
||||
* `uninstall :rmdir`
|
||||
* `uninstall :trash`
|
||||
* *stub* - currently just a synonym for `uninstall :delete`
|
||||
* `zap`
|
||||
|
||||
|
||||
## Renames (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`
|
||||
| `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`
|
||||
|
||||
|
||||
## All Supported Stanzas (1.0)
|
||||
|
||||
**Stub!**
|
||||
* [Other Supported Non-stanza Methods (1.0)](#other-supported-non-stanza-methods-10)
|
||||
* [Caveats Mini-DSL (1.0)](#caveats-mini-dsl-10)
|
||||
|
||||
|
||||
## Header Line (1.0)
|
||||
@@ -104,6 +48,114 @@ 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`](CASK_LANGUAGE_REFERENCE.md#appcast-stanza-details)
|
||||
* [`artifact`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`depends_on :cask`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`depends_on :macos`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`depends_on :arch`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`depends_on :x11`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`depends_on :java`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`conflicts_with`](CASK_LANGUAGE_REFERENCE.md#conflicts_with-stanza-details)
|
||||
* *stub* - not yet functional
|
||||
* [`gpg`](CASK_LANGUAGE_REFERENCE.md#gpg-stanza-details) *stub: not yet functional.*
|
||||
* [`installer :script`](CASK_LANGUAGE_REFERENCE.md#installer-stanza-details)
|
||||
* [`license`](CASK_LANGUAGE_REFERENCE.md#license-stanza-details)
|
||||
* [`stage_only`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* replaced undocumented `caskroom_only`
|
||||
* [`suite`](CASK_LANGUAGE_REFERENCE.md#suite-stanza-details)
|
||||
* [`tags`](CASK_LANGUAGE_REFERENCE.md#tags-stanza-details)
|
||||
* [`uninstall :rmdir`](CASK_LANGUAGE_REFERENCE.md#uninstall-stanza-details)
|
||||
* [`uninstall :trash`](CASK_LANGUAGE_REFERENCE.md#uninstall-stanza-details)
|
||||
* *stub* - currently just a synonym for `uninstall :delete`
|
||||
* [`zap`](CASK_LANGUAGE_REFERENCE.md#zap-stanza-details)
|
||||
|
||||
|
||||
## Renamed Forms (1.0)
|
||||
|
||||
| old form | new form
|
||||
| ------------------------------------------- |----------------
|
||||
| `after_install` | [`postflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `after_uninstall` | [`uninstall_postflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `before_install` | [`preflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `before_uninstall` | [`uninstall_preflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `container_type` | [`container :type`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `depends_on_formula` | [`depends_on :formula`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
| `destination_path` | [`staged_path`](CASK_LANGUAGE_REFERENCE.md#caveats-as-a-string)
|
||||
| `install` | [`pkg`](CASK_LANGUAGE_REFERENCE.md#pkg-stanza-details)
|
||||
| `link` | [`app`](CASK_LANGUAGE_REFERENCE.md#app-stanza-details) (or sometimes `suite` or `artifact`)
|
||||
| `manual_installer(path)` (within `caveats`) | [`installer :manual`](CASK_LANGUAGE_REFERENCE.md#installer-stanza-details)
|
||||
| `nested_container` | [`container :nested =>`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
| `uninstall :files` | [`uninstall :delete`](CASK_LANGUAGE_REFERENCE.md#uninstall-stanza-details)
|
||||
| `version 'latest'` | [`version :latest`](CASK_LANGUAGE_REFERENCE.md#required-stanzas)
|
||||
|
||||
|
||||
## All Supported Stanzas (1.0)
|
||||
|
||||
* [`app`](CASK_LANGUAGE_REFERENCE.md#app-stanza-details)
|
||||
* [`appcast`](CASK_LANGUAGE_REFERENCE.md#appcast-stanza-details)
|
||||
* [`artifact`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`binary`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`caveats`](CASK_LANGUAGE_REFERENCE.md#caveats-stanza-details)
|
||||
* [`colorpicker`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`conflicts_with`](CASK_LANGUAGE_REFERENCE.md#conflicts_with-stanza-details)
|
||||
* [`container`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`depends_on`](CASK_LANGUAGE_REFERENCE.md#depends_on-stanza-details)
|
||||
* [`font`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`gpg`](CASK_LANGUAGE_REFERENCE.md#gpg-stanza-details) *stub: not yet functional.*
|
||||
* [`homepage`](CASK_LANGUAGE_REFERENCE.md#required-stanzas)
|
||||
* [`input_method`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`installer`](CASK_LANGUAGE_REFERENCE.md#installer-stanza-details)
|
||||
* [`internet_plugin`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`license`](CASK_LANGUAGE_REFERENCE.md#license-stanza-details)
|
||||
* [`pkg`](CASK_LANGUAGE_REFERENCE.md#pkg-stanza-details)
|
||||
* [`postflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`preflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`prefpane`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`qlplugin`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`screen_saver`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`service`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`sha256`](CASK_LANGUAGE_REFERENCE.md#checksum-stanza-details)
|
||||
* [`stage_only`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`suite`](CASK_LANGUAGE_REFERENCE.md#suite-stanza-details)
|
||||
* [`tags`](CASK_LANGUAGE_REFERENCE.md#tags-stanza-details)
|
||||
* [`uninstall_postflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`uninstall_preflight`](CASK_LANGUAGE_REFERENCE.md#optional-stanzas)
|
||||
* [`uninstall`](CASK_LANGUAGE_REFERENCE.md#uninstall-stanza-details)
|
||||
* [`url`](CASK_LANGUAGE_REFERENCE.md#url-stanza-details)
|
||||
* [`version`](CASK_LANGUAGE_REFERENCE.md#required-stanzas)
|
||||
* [`widget`](CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required)
|
||||
* [`zap`](CASK_LANGUAGE_REFERENCE.md#zap-stanza-details)
|
||||
|
||||
|
||||
## Other Supported Non-stanza Methods (1.0)
|
||||
|
||||
For use in *eg* interpolation:
|
||||
|
||||
* [`caskroom_path`](CASK_LANGUAGE_REFERENCE.md#caveats-as-a-string)
|
||||
* [`staged_path`](CASK_LANGUAGE_REFERENCE.md#caveats-as-a-string)
|
||||
* [`title`](CASK_LANGUAGE_REFERENCE.md#caveats-as-a-string)
|
||||
|
||||
|
||||
## Caveats Mini-DSL (1.0)
|
||||
|
||||
* [`arch_only(list)`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`assistive_devices`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`files_in_usr_local`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`logout`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`os_version_only(list)`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`path_environment_variable(path)`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`reboot`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`x11_required`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
* [`zsh_path_helper(path)`](CASK_LANGUAGE_REFERENCE.md#caveats-mini-dsl)
|
||||
|
||||
|
||||
## References
|
||||
|
||||
* [DSL 1.0 transition notice](https://github.com/caskroom/homebrew-cask/issues/5890)
|
||||
|
||||
Reference in New Issue
Block a user