a1993b9086
Formula caveats text appears on formulae.brew.sh but escape characters, as used in ANSI escape codes, should not appear in HTML. This commit adds a RuboCop to disallow escape characters in the caveats text.
48 lines
1.2 KiB
Ruby
48 lines
1.2 KiB
Ruby
# typed: false
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/caveats"
|
|
|
|
describe RuboCop::Cop::FormulaAudit::Caveats do
|
|
subject(:cop) { described_class.new }
|
|
|
|
context "when auditing `caveats`" do
|
|
it "reports an offense if `setuid` is mentioned" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
homepage "https://brew.sh/foo"
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
def caveats
|
|
"setuid"
|
|
^^^^^^^^ Don't recommend setuid in the caveats, suggest sudo instead.
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
|
|
it "reports an offense if an escape character is present" do
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
homepage "https://brew.sh/foo"
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
def caveats
|
|
"\\x1B"
|
|
^^^^^^ Don't use ANSI escape codes in the caveats.
|
|
end
|
|
end
|
|
RUBY
|
|
|
|
expect_offense(<<~RUBY)
|
|
class Foo < Formula
|
|
homepage "https://brew.sh/foo"
|
|
url "https://brew.sh/foo-1.0.tgz"
|
|
def caveats
|
|
"\\u001b"
|
|
^^^^^^^^ Don't use ANSI escape codes in the caveats.
|
|
end
|
|
end
|
|
RUBY
|
|
end
|
|
end
|
|
end
|