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 ```
51 lines
1.5 KiB
Ruby
51 lines
1.5 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "forwardable"
|
|
require "uri"
|
|
require "rubocops/shared/homepage_helper"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# This cop audits the `homepage` URL in casks.
|
|
class HomepageUrlStyling < Base
|
|
include OnHomepageStanza
|
|
include HelperFunctions
|
|
include HomepageHelper
|
|
extend AutoCorrector
|
|
|
|
MSG_NO_SLASH = "'%<url>s' must have a slash after the domain."
|
|
|
|
def on_homepage_stanza(stanza)
|
|
@name = cask_block.header.cask_token
|
|
desc_call = stanza.stanza_node
|
|
url_node = desc_call.first_argument
|
|
|
|
url = if url_node.dstr_type?
|
|
# Remove quotes from interpolated string.
|
|
url_node.source[1..-2]
|
|
else
|
|
url_node.str_content
|
|
end
|
|
|
|
audit_homepage(:cask, url, desc_call, url_node)
|
|
|
|
return unless url&.match?(%r{^.+://[^/]+$})
|
|
|
|
domain = URI(string_content(url_node, strip_dynamic: true)).host
|
|
return if domain.blank?
|
|
|
|
# This also takes URLs like 'https://example.org?path'
|
|
# and 'https://example.org#path' into account.
|
|
corrected_source = url_node.source.sub("://#{domain}", "://#{domain}/")
|
|
|
|
add_offense(url_node.loc.expression, message: format(MSG_NO_SLASH, url:)) do |corrector|
|
|
corrector.replace(url_node.source_range, corrected_source)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|