DSL 1.0 followups

[rolandwalker]

These items have been bumped from DSL 1.0 roadmap #4688, which now contains only the items needed for merging metadata support.

• Cask followups
  • relabel Cask tokens which start with numbers (onepassword is now 1password #8002, use leading numbers in 9 Cask tokens #8018, homebrew-versions#607)
  • enable commented-out name stanzas, main repo (Enable name stanzas in 8 Casks #7978)
  • MacOS.release switchover, all repos (Use new form MacOS.release in 45 Casks #7982, Enable new form MacOS.release in 2 Casks homebrew-cask-versions#600)
  • add more name stanzas, main repo
  • enable accessibility_access stanzas, main repo (Enable new accessibility_access form in 4 Casks #7981)
  • replace #{self.name...} hack in caveats with #{token}, all repos (Enable the new token form in 23 Casks #7979, Enable new token method in 2 Casks homebrew-cask-versions#599)
  • seed tags :vendor values from Info.plist? (along with "auto-generated" comment?)
  • seed zap stanzas from mackup and other sources (Mackup zap stanza import #6174, add or expand zap stanzas in 53 Casks #6609, zap stanza for onepassword #6863, Add/update zap stanzas in 12 Casks #6899)
    • one pass done (easy matches)
    • could use another pass
  • seed license stanzas from GitHub projects with LICENSE files (Specify more licenses (letter A) #6645, Specify most licenses for letter B #6693, Specify various licenses #6633, many more todo)
• review system_command postflight
  • CASK_LANGUAGE_REFERENCE.md
  • cask_language_deltas.md
  • amend Casks, all repos
• test suite followups
  • various depends_on stubs
  • conflicts_with (all stubs)
  • installer :script (there is one test, but another would be good)
  • installer :manual
  • uninstall :trash
• backend followups
  • improve suite documentation
  • delete all backward-compat code not covered above: search code for
    • todo
    • temporary
    • transition
    • DSL
    • fixme
    • removeme
    • 0.50
    • 1.0
    • backward
    • forward
    • deprecated
  • require license stanza (which may have value :unknown)
  • enforce all required stanzas per documentation
  • enforce at least one artifact per documentation
  • enforce new semantics
    • app should only take an app bundle
    • suite should take a directory, but not an app bundle
    • generic artifact should require :target
    • others?
  • require uninstall
    • may need uninstall :none for exceptional cases
    • require uninstall with pkg
    • require uninstall with installer (need to fix many Casks first)
  • refactor variables, methods, and classes as needed to match new forms
    • app (remove support for link artifact #7065)
    • suite (does not even have an associated class yet) (remove support for link artifact #7065)
    • artifact (remove support for link artifact #7065)
    • link (remove) (remove support for link artifact #7065)
    • pkg
    • preflight, postflight, uninstall_preflight, uninstall_postflight (Refactor backend classes to match preflight/postflight #7642)
    • license
    • depends_on :formula
    • other depends_on stubs
    • conflicts_with (all stubs)
    • gpg (not altered)
    • version :latest as symbol
    • zap (not altered)
    • appcast (new keys)
    • installer :script
    • installer :manual
    • uninstall :delete
    • uninstall :trash
    • tags (not altered)
    • container :type
    • container :nested (more work than others: convert away from a pseudo-artifact)
      • :nested_container is also referenced in a Cask
    • uninstall :rmdir (not altered)
    • token (unify and recast "Cask name" and "title" as "token" #7673)
  • add zap verb (functionality and docs for zap stanza and verb #6155)
    • expand tilde in :delete values
    • different treatment of relative paths in :delete (protect against inner ".." in uninstall paths #6193)
    • informative message when no zap stanza present (Improve zap feedback messages #6207)
  • add uninstall --force (related to zap implementation) (add --force option for brew cask uninstall #6208)
  • static Cask dumps
    • requires completing container :nested refactor, or applying workaround in the dump method
    • each form should provide to_static instead of to_yaml, returning a data structure which includes the stanza name
    • existing _dump verb should return full YAML structure instead of fragments
    • remove need to list dumpable forms twice (check Cask::DSL constants instead)
    • add JSON format
    • refactor dump so that setting debug flag is not needed
  • ability to search/filter/display tags
  • ability to search/filter/display licenses
  • implement dependencies
    • depends_on :java
    • depends_on :cask
    • conflicts_with :cask
    • conflicts_with :formula
  • new verb verify which also covers gpg checks
  • uninstall :trash support
  • launch verb respecting app
  • _appcast verb which fetches and tests appcast checksums
  • expose version numbers extracted from app Info.plist
    • could be displayed in ls --versions (Add support for displaying versions in list command #5987)
  • command verbs preflight, postflight, uninstall_preflight, uninstall_postflight
    • new --dry-run option would be useful here
  • special treatment for version :latest symbol
    • cached downloads should expire quickly (Casks with :latest install obsolete cached versions #6087)

[tapeinosyne]

• new verb checksum which also covers gpg checks

Perhaps a generic verify verb would be a more descriptive and future-proof alternative, in case we started including other verification steps (e.g. as suggested in #7062).

[rolandwalker]

Amended. You should also feel free to edit these these tracker issues directly.

[jawshooah]

We should extract any useful items into their own issues and close this. @vitorgalvao, what do you think about this list?

[vitorgalvao]

@jawshooah On a first look through it, these seem to be what’s worth keeping:

• test suite followups
  • various depends_on stubs
  • conflicts_with (all stubs)
  • installer :script (there is one test, but another would be good)
  • installer :manual
  • uninstall :trash
• backend followups
  • improve suite documentation
  • delete all backward-compat code not covered above: search code for
    • todo
    • temporary
    • transition
    • DSL
    • removeme
    • backward
  • enforce at least one artifact per documentation
  • generic artifact should require :target
  • require uninstall with pkg
  • require uninstall with installer (need to fix some Casks first)
  • implement dependencies
    • depends_on :java
    • conflicts_with :cask
    • conflicts_with :formula
  • new verb verify which also covers gpg checks
  • uninstall :trash support

Some of these may already have issues in place (or be fixed, even), but would have to check.

[josephholsten]

created #36821 to discuss potential impl of _appcast verb

[vitorgalvao]

@reitermarkus @claui This issue is outdated as hell, so I’m going to close. Pinging you as reference in case you feel it’s worth it to move something from the list to their own issues.

If you do but don’t want to make the issues yourselves, tell me which ones you’d like to see, and I’ll open them.