brew/Library/Homebrew/yard/templates/default/docstring/html/setup.rb

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true

# This follows the docs at https://github.com/lsegal/yard/blob/main/docs/Templates.md#setuprb
# rubocop:disable Style/TopLevelMethodDefinition
def init
  # `sorbet` is available transitively through the `yard-sorbet` plugin, but we're
  # outside of the standalone sorbet config, so `checked` is enabled by default
  T.bind(self, T.all(Class, YARD::Templates::Template), checked: false)
  super

  return if sections.empty?

  sections[:index].place(:internal).before(:private)
end

def internal
  T.bind(self, YARD::Templates::Template, checked: false)
  erb(:internal) if object.has_tag?(:api) && object.tag(:api).text == "internal"
end
# rubocop:enable Style/TopLevelMethodDefinition
rubocop: Use `Sorbet/StrictSigil` as it's better than comments - 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 ``` 2024-08-12 10:30:59 +01:00			`# typed: true # rubocop:todo Sorbet/StrictSigil`
Move YARD config into `Library/Homebrew`. 2021-03-30 04:38:45 +02:00			`# frozen_string_literal: true`

Enable Style/TopLevelMethodDefinition 2024-01-26 11:36:08 -08:00			`# This follows the docs at https://github.com/lsegal/yard/blob/main/docs/Templates.md#setuprb`
			`# rubocop:disable Style/TopLevelMethodDefinition`
Move YARD config into `Library/Homebrew`. 2021-03-30 04:38:45 +02:00			`def init`
Minor YARD improvements 2023-04-05 10:06:45 -07:00			# `sorbet` is available transitively through the `yard-sorbet` plugin, but we're
			# outside of the standalone sorbet config, so `checked` is enabled by default
resolve typecheck errors 2023-11-05 08:55:58 -08:00			`T.bind(self, T.all(Class, YARD::Templates::Template), checked: false)`
Move YARD config into `Library/Homebrew`. 2021-03-30 04:38:45 +02:00			`super`

			`return if sections.empty?`

			`sections[:index].place(:internal).before(:private)`
			`end`

			`def internal`
Minor YARD improvements 2023-04-05 10:06:45 -07:00			`T.bind(self, YARD::Templates::Template, checked: false)`
Move YARD config into `Library/Homebrew`. 2021-03-30 04:38:45 +02:00			`erb(:internal) if object.has_tag?(:api) && object.tag(:api).text == "internal"`
			`end`
Enable Style/TopLevelMethodDefinition 2024-01-26 11:36:08 -08:00			`# rubocop:enable Style/TopLevelMethodDefinition`