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 ```
37 lines
1.0 KiB
Ruby
37 lines
1.0 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module Homebrew
|
|
class FormulaNameCaskTokenAuditor
|
|
sig { returns(String) }
|
|
attr_reader :token
|
|
|
|
sig { params(token: String).void }
|
|
def initialize(token)
|
|
@token = token
|
|
end
|
|
|
|
sig { returns(T::Array[String]) }
|
|
def errors
|
|
errors = []
|
|
|
|
errors << "uppercase letters" if token.match?(/[A-Z]/)
|
|
errors << "whitespace" if token.match?(/\s/)
|
|
errors << "non-ASCII characters" unless token.ascii_only?
|
|
errors << "double hyphens" if token.include?("--")
|
|
|
|
errors << "a leading @" if token.start_with?("@")
|
|
errors << "a trailing @" if token.end_with?("@")
|
|
errors << "a leading hyphen" if token.start_with?("-")
|
|
errors << "a trailing hyphen" if token.end_with?("-")
|
|
|
|
errors << "multiple @ symbols" if token.count("@") > 1
|
|
|
|
errors << "a hyphen followed by an @" if token.include? "-@"
|
|
errors << "an @ followed by a hyphen" if token.include? "@-"
|
|
|
|
errors
|
|
end
|
|
end
|
|
end
|