mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
113 lines
3.8 KiB
Ruby
113 lines
3.8 KiB
Ruby
# typed: false
|
|
# frozen_string_literal: true
|
|
|
|
require "rubocops/shared/helper_functions"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
# This module performs common checks the `desc` field in both formulae and casks.
|
|
#
|
|
# @api private
|
|
module DescHelper
|
|
include HelperFunctions
|
|
|
|
MAX_DESC_LENGTH = 80
|
|
|
|
VALID_LOWERCASE_WORDS = %w[
|
|
iOS
|
|
iPhone
|
|
macOS
|
|
].freeze
|
|
|
|
def audit_desc(type, name, desc_call)
|
|
# Check if a desc is present.
|
|
if desc_call.nil?
|
|
problem "#{type.to_s.capitalize} should have a desc (Description)."
|
|
return
|
|
end
|
|
|
|
@offensive_node = desc_call
|
|
@offense_source_range = desc_call.source_range
|
|
|
|
desc = desc_call.first_argument
|
|
|
|
# Check if the desc is empty.
|
|
desc_length = string_content(desc).length
|
|
if desc_length.zero?
|
|
problem "The desc (description) should not be an empty string."
|
|
return
|
|
end
|
|
|
|
# Check the desc for leading whitespace.
|
|
problem "Description shouldn't have leading spaces." if regex_match_group(desc, /^\s+/)
|
|
|
|
# Check the desc for trailing whitespace.
|
|
problem "Description shouldn't have trailing spaces." if regex_match_group(desc, /\s+$/)
|
|
|
|
# Check if "command-line" is spelled incorrectly in the desc.
|
|
if match = regex_match_group(desc, /(command ?line)/i)
|
|
c = match.to_s[0]
|
|
problem "Description should use \"#{c}ommand-line\" instead of \"#{match}\"."
|
|
end
|
|
|
|
# Check if the desc starts with an article.
|
|
problem "Description shouldn't start with an article." if regex_match_group(desc, /^(the|an?)(?=\s)/i)
|
|
|
|
# Check if invalid lowercase words are at the start of a desc.
|
|
if !VALID_LOWERCASE_WORDS.include?(string_content(desc).split.first) &&
|
|
regex_match_group(desc, /^[a-z]/)
|
|
problem "Description should start with a capital letter."
|
|
end
|
|
|
|
# Check if the desc starts with the formula's or cask's name.
|
|
name_regex = name.delete("-").split("").join('[\s\-]?')
|
|
problem "Description shouldn't start with the #{type} name." if regex_match_group(desc, /^#{name_regex}\b/i)
|
|
|
|
if type == :cask &&
|
|
(match = regex_match_group(desc, /\b(macOS|Mac( ?OS( ?X)?)?|OS ?X)(?! virtual machines?)\b/i)) &&
|
|
match[1] != "MAC"
|
|
problem "Description shouldn't contain the platform."
|
|
end
|
|
|
|
# Check if a full stop is used at the end of a desc (apart from in the case of "etc.").
|
|
if regex_match_group(desc, /\.$/) && !string_content(desc).end_with?("etc.")
|
|
problem "Description shouldn't end with a full stop."
|
|
end
|
|
|
|
# Check if the desc length exceeds maximum length.
|
|
return if desc_length <= MAX_DESC_LENGTH
|
|
|
|
problem "Description is too long. It should be less than #{MAX_DESC_LENGTH} characters. " \
|
|
"The current length is #{desc_length}."
|
|
end
|
|
|
|
def autocorrect_desc(node, name)
|
|
lambda do |corrector|
|
|
/\A(?<quote>["'])(?<correction>.*)(?:\k<quote>)\Z/ =~ node.source
|
|
|
|
next if correction.nil?
|
|
|
|
correction.gsub!(/^\s+/, "")
|
|
correction.gsub!(/\s+$/, "")
|
|
|
|
correction.sub!(/^(the|an?)\s+/i, "")
|
|
|
|
first_word = correction.split.first
|
|
unless VALID_LOWERCASE_WORDS.include?(first_word)
|
|
first_char = first_word.to_s[0]
|
|
correction[0] = first_char.upcase if first_char
|
|
end
|
|
|
|
correction.gsub!(/(ommand ?line)/i, "ommand-line")
|
|
correction.gsub!(/(^|[^a-z])#{name}([^a-z]|$)/i, "\\1\\2")
|
|
correction.gsub!(/^\s+/, "")
|
|
correction.gsub!(/\s+$/, "")
|
|
correction.gsub!(/\.$/, "")
|
|
|
|
corrector.replace(node.source_range, "#{quote}#{correction}#{quote}")
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|