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 ```
55 lines
1.7 KiB
Ruby
55 lines
1.7 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "kramdown/converter/man"
|
|
|
|
module Homebrew
|
|
module Manpages
|
|
module Converter
|
|
# Converts our Kramdown-like input to roff.
|
|
class Roff < ::Kramdown::Converter::Man
|
|
# Override that adds Homebrew metadata for the top level header
|
|
# and doesn't escape the text inside subheaders.
|
|
def convert_header(element, options)
|
|
if element.options[:level] == 1
|
|
element.attr["data-date"] = Date.today.strftime("%B %Y")
|
|
element.attr["data-extra"] = "Homebrew"
|
|
return super
|
|
end
|
|
|
|
result = +""
|
|
inner(element, options.merge(result:))
|
|
result.gsub!(" [", ' \fR[') # make args not bold
|
|
|
|
options[:result] << if element.options[:level] == 2
|
|
macro("SH", quote(result))
|
|
else
|
|
macro("SS", quote(result))
|
|
end
|
|
end
|
|
|
|
def convert_variable(element, options)
|
|
options[:result] << "\\fI#{escape(element.value)}\\fP"
|
|
end
|
|
|
|
def convert_a(element, options)
|
|
if element.attr["href"].chr == "#"
|
|
# Hide internal links - just make them italicised
|
|
convert_em(element, options)
|
|
else
|
|
super
|
|
# Remove the space after links if the next character is not a space
|
|
if options[:result].end_with?(".UE\n") &&
|
|
(next_element = options[:next]) &&
|
|
next_element.type == :text &&
|
|
next_element.value.chr.present? # i.e. not a space character
|
|
options[:result].chomp!
|
|
options[:result] << " "
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|