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 ```
39 lines
1.0 KiB
Ruby
39 lines
1.0 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "warning"
|
|
|
|
# Helper module for handling warnings.
|
|
module Warnings
|
|
COMMON_WARNINGS = {
|
|
parser_syntax: [
|
|
%r{warning: parser/current is loading parser/ruby\d+, which recognizes},
|
|
/warning: \d+\.\d+\.\d+-compliant syntax, but you are running \d+\.\d+\.\d+\./,
|
|
# FIXME: https://github.com/errata-ai/vale/issues/818
|
|
# <!-- vale off -->
|
|
%r{warning: please see https://github\.com/whitequark/parser#compatibility-with-ruby-mri\.},
|
|
# <!-- vale on -->
|
|
],
|
|
default_gems: [
|
|
/warning: .+\.rb was loaded from the standard library, .+ default gems since Ruby \d+\.\d+\.\d+\./,
|
|
],
|
|
}.freeze
|
|
|
|
def self.ignore(*warnings)
|
|
warnings.map! do |warning|
|
|
next warning if !warning.is_a?(Symbol) || !COMMON_WARNINGS.key?(warning)
|
|
|
|
COMMON_WARNINGS[warning]
|
|
end
|
|
|
|
warnings.flatten.each do |warning|
|
|
Warning.ignore warning
|
|
end
|
|
return unless block_given?
|
|
|
|
result = yield
|
|
Warning.clear
|
|
result
|
|
end
|
|
end
|