This commit is contained in:
Markus Reiter 2024-04-22 21:22:22 +02:00
parent 4b432c7ea4
commit 26d1ff5ccb
No known key found for this signature in database
GPG Key ID: 245293B51702655B
3 changed files with 12 additions and 10 deletions

View File

@ -61,13 +61,14 @@ jobs:
- name: Check RuboCop filepaths - name: Check RuboCop filepaths
working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/Library/Homebrew working-directory: ${{ steps.set-up-homebrew.outputs.repository-path }}/Library/Homebrew
run: | run: |
public_apis=$(git grep -l "@api public" -- :^sorbet/ :^vendor/ | wc -l | tr -d ' ') public_apis="$(git grep -l "@api public" -- :^sorbet/ :^vendor/ | sort)"
rubocop_docs=$(yq '.Style/Documentation.Include' .rubocop.yml | wc -l | tr -d ' ') rubocop_docs="$(yq '.Style/Documentation.Include[]' .rubocop.yml | sort)"
if [[ public_apis -ne rubocop_docs ]]
then if [[ "${public_apis}" != "${rubocop_docs}" ]]; then
echo "All public Homebrew APIs should be included in the Style/Documentation RuboCop." echo "All public Homebrew APIs should be included in the \`Style/Documentation\` RuboCop."
echo "There were ${public_apis} '@api public' lines but ${rubocop_docs} filepaths for the 'Style/Documentation' RuboCop." echo "Add/remove the following paths from \`Library/Homebrew/.rubocop.yml\` as appropriate:"
echo "Add or remove the filepaths from Library/Homebrew/.rubocop.yml as appropriate." echo "${public_apis} ${rubocop_docs}" | tr ' ' '\n' | sort | uniq -u
exit 1 exit 1
fi fi

View File

@ -64,6 +64,7 @@ Style/Documentation:
- utils/shebang.rb - utils/shebang.rb
- utils/string_inreplace_extension.rb - utils/string_inreplace_extension.rb
- version.rb - version.rb
- tap.rb
Style/DocumentationMethod: Style/DocumentationMethod:
Include: Include:

View File

@ -22,7 +22,7 @@ module Cask
# The token of this {Cask}. # The token of this {Cask}.
# #
# @api public # @api internal
attr_reader :token attr_reader :token
# The configuration of this {Cask}. # The configuration of this {Cask}.
@ -136,7 +136,7 @@ module Cask
# The fully-qualified token of this {Cask}. # The fully-qualified token of this {Cask}.
# #
# @api public # @api internal
def full_token def full_token
return token if tap.nil? return token if tap.nil?
return token if tap.core_cask_tap? return token if tap.core_cask_tap?
@ -327,7 +327,7 @@ module Cask
# Alias for {#token}. # Alias for {#token}.
# #
# @api public # @api internal
def to_s = token def to_s = token
def inspect def inspect