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 ```
48 lines
1.2 KiB
Ruby
48 lines
1.2 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "sorbet-runtime"
|
|
require "extend/module"
|
|
|
|
# Disable runtime checking unless enabled.
|
|
# In the future we should consider not doing this monkey patch,
|
|
# if assured that there is no performance hit from removing this.
|
|
# There are mechanisms to achieve a middle ground (`default_checked_level`).
|
|
unless ENV["HOMEBREW_SORBET_RUNTIME"]
|
|
# Redefine `T.let`, etc. to make the `checked` parameter default to `false` rather than `true`.
|
|
# @private
|
|
module TNoChecks
|
|
def cast(value, type, checked: false)
|
|
super
|
|
end
|
|
|
|
def let(value, type, checked: false)
|
|
super
|
|
end
|
|
|
|
def bind(value, type, checked: false)
|
|
super
|
|
end
|
|
|
|
def assert_type!(value, type, checked: false)
|
|
super
|
|
end
|
|
end
|
|
|
|
# @private
|
|
module T
|
|
class << self
|
|
prepend TNoChecks
|
|
end
|
|
|
|
# Redefine `T.sig` to be a no-op.
|
|
module Sig
|
|
def sig(arg0 = nil, &blk); end
|
|
end
|
|
end
|
|
|
|
# For any cases the above doesn't handle: make sure we don't let TypeError slip through.
|
|
T::Configuration.call_validation_error_handler = ->(signature, opts) {}
|
|
T::Configuration.inline_type_error_handler = ->(error, opts) {}
|
|
end
|