From a3f4b6e172385a24ab31f3b047904848ca08742f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=ADtor=20Galv=C3=A3o?= Date: Mon, 11 Jan 2016 01:57:38 +0000 Subject: [PATCH] CONTRIBUTING.md: move stanza order to style guide section --- CONTRIBUTING.md | 114 ++++++++++++++++++++++++------------------------ 1 file changed, 57 insertions(+), 57 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c7631dbfc39..c6d9aa7ea3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -205,63 +205,6 @@ Other commonly-used stanzas are: Additional `artifact` stanzas you might need for special use-cases can be found [here](doc/CASK_LANGUAGE_REFERENCE.md#at-least-one-artifact-stanza-is-also-required). Even more special-use stanzas are listed at [Optional Stanzas](doc/CASK_LANGUAGE_REFERENCE.md#optional-stanzas) and [Legacy Stanzas](doc/CASK_LANGUAGE_REFERENCE.md#legacy-stanzas). -### Stanza order - -Having a common order for stanzas makes Casks easier to update and parse. Below is the the complete stanza sequence (no Cask will have all stanzas). The empty lines shown here are also important, as they help to visually delineate information. - -``` -version -sha256 - -url -appcast, - :sha256 # shown here as it is required with `appcast` -name -homepage -license -gpg, :key_id # on same line, since first part is typically small - -auto_updates -accessibility_access -conflicts_with -depends_on -container - -suite -app -pkg -installer -binary -colorpicker -font -input_method -internet_plugin -prefpane -qlplugin -screen_saver -service -audio_unit_plugin -vst_plugin -artifact, :target # :target shown here as is required with `artifact` -stage_only - -preflight - -postflight - -uninstall_preflight - -uninstall_postflight - -uninstall - -zap - -caveats -``` - -Note that every stanza that has additional parameters (`:symbols` after a `,`) shall have them on separate lines, one per line, in alphabetical order. Exceptions are `gpg` and `:target` (when not applied to `url`) which typically consist of short lines. - ### SourceForge/OSDN URLs SourceForge and OSDN (formerly SourceForge.JP) projects are common ways to distribute binaries, but they provide many different styles of URLs to get to the goods. @@ -343,6 +286,63 @@ cask 'lynkeos' do end ``` +#### Stanza order + +Having a common order for stanzas makes Casks easier to update and parse. Below is the the complete stanza sequence (no Cask will have all stanzas). The empty lines shown here are also important, as they help to visually delineate information. + +``` +version +sha256 + +url +appcast, + :sha256 # shown here as it is required with `appcast` +name +homepage +license +gpg, :key_id # on same line, since first part is typically small + +auto_updates +accessibility_access +conflicts_with +depends_on +container + +suite +app +pkg +installer +binary +colorpicker +font +input_method +internet_plugin +prefpane +qlplugin +screen_saver +service +audio_unit_plugin +vst_plugin +artifact, :target # :target shown here as is required with `artifact` +stage_only + +preflight + +postflight + +uninstall_preflight + +uninstall_postflight + +uninstall + +zap + +caveats +``` + +Note that every stanza that has additional parameters (`:symbols` after a `,`) shall have them on separate lines, one per line, in alphabetical order. Exceptions are `gpg` and `:target` (when not applied to `url`) which typically consist of short lines. + ## Testing Your New Cask Give it a shot with `brew cask install my-new-cask`