45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
75 lines
2.0 KiB
Ruby
75 lines
2.0 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "forwardable"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# This cop checks that a cask's stanzas are ordered correctly, including nested within `on_*` blocks.
|
|
# @see https://docs.brew.sh/Cask-Cookbook#stanza-order
|
|
class StanzaOrder < Base
|
|
include IgnoredNode
|
|
extend Forwardable
|
|
extend AutoCorrector
|
|
include CaskHelp
|
|
|
|
MESSAGE = "`%<stanza>s` stanza out of order"
|
|
|
|
def on_cask_stanza_block(stanza_block)
|
|
stanzas = stanza_block.stanzas
|
|
ordered_stanzas = sort_stanzas(stanzas)
|
|
|
|
return if stanzas == ordered_stanzas
|
|
|
|
stanzas.zip(ordered_stanzas).each do |stanza_before, stanza_after|
|
|
next if stanza_before == stanza_after
|
|
|
|
add_offense(
|
|
stanza_before.method_node,
|
|
message: format(MESSAGE, stanza: stanza_before.stanza_name),
|
|
) do |corrector|
|
|
next if part_of_ignored_node?(stanza_before.method_node)
|
|
|
|
corrector.replace(
|
|
stanza_before.source_range_with_comments,
|
|
stanza_after.source_with_comments,
|
|
)
|
|
|
|
# Ignore node so that nested content is not auto-corrected and clobbered.
|
|
ignore_node(stanza_before.method_node)
|
|
end
|
|
end
|
|
end
|
|
|
|
def on_new_investigation
|
|
super
|
|
|
|
ignored_nodes.clear
|
|
end
|
|
|
|
private
|
|
|
|
def sort_stanzas(stanzas)
|
|
stanzas.sort do |stanza1, stanza2|
|
|
i1 = stanza1.stanza_index
|
|
i2 = stanza2.stanza_index
|
|
|
|
if i1 == i2
|
|
i1 = stanzas.index(stanza1)
|
|
i2 = stanzas.index(stanza2)
|
|
end
|
|
|
|
i1 - i2
|
|
end
|
|
end
|
|
|
|
def stanza_order_index(stanza)
|
|
stanza_name = stanza.respond_to?(:method_name) ? stanza.method_name : stanza.stanza_name
|
|
RuboCop::Cask::Constants::STANZA_ORDER.index(stanza_name)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|