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 ```
42 lines
1.4 KiB
Ruby
42 lines
1.4 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "kramdown/parser/kramdown"
|
|
|
|
module Homebrew
|
|
module Manpages
|
|
module Parser
|
|
# Kramdown parser with compatiblity for ronn variable syntax.
|
|
class Ronn < ::Kramdown::Parser::Kramdown
|
|
def initialize(*)
|
|
super
|
|
# Disable HTML parsing and replace it with variable parsing.
|
|
# Also disable table parsing too because it depends on HTML parsing
|
|
# and existing command descriptions may get misinterpreted as tables.
|
|
# Typographic symbols is disabled as it detects `--` as en-dash.
|
|
@block_parsers.delete(:block_html)
|
|
@block_parsers.delete(:table)
|
|
@span_parsers.delete(:span_html)
|
|
@span_parsers.delete(:typographic_syms)
|
|
@span_parsers << :variable
|
|
end
|
|
|
|
# HTML-like tags denote variables instead, except <br>.
|
|
VARIABLE_REGEX = /<([\w\-\|]+)>/
|
|
def parse_variable
|
|
start_line_number = @src.current_line_number
|
|
@src.scan(VARIABLE_REGEX)
|
|
variable = @src[1]
|
|
if variable == "br"
|
|
@src.skip(/\n/)
|
|
@tree.children << Element.new(:br, nil, nil, location: start_line_number)
|
|
else
|
|
@tree.children << Element.new(:variable, variable, nil, location: start_line_number)
|
|
end
|
|
end
|
|
define_parser(:variable, VARIABLE_REGEX, "<")
|
|
end
|
|
end
|
|
end
|
|
end
|