Sha256: a52d079ef55c66dffbcc9a511e7193d904bfa3e758e900ba443389b4cfbe5ceb

Contents?: true

Size: 1.05 KB

Versions: 186

Compression:

Stored size: 1.05 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # Enforces that Ruby source files are not empty.
      #
      # @example
      #   # bad
      #   # Empty file
      #
      #   # good
      #   # File containing non commented source lines
      #
      # @example AllowComments: true (default)
      #   # good
      #   # File consisting only of comments
      #
      # @example AllowComments: false
      #   # bad
      #   # File consisting only of comments
      #
      class EmptyFile < Base
        include RangeHelp

        MSG = 'Empty file detected.'

        def on_new_investigation
          add_global_offense(MSG) if offending?
        end

        private

        def offending?
          empty_file? || (!cop_config['AllowComments'] && contains_only_comments?)
        end

        def empty_file?
          processed_source.buffer.source.empty?
        end

        def contains_only_comments?
          processed_source.lines.all? { |line| line.blank? || comment_line?(line) }
        end
      end
    end
  end
end

Version data entries

186 entries across 179 versions & 17 rubygems

Version Path
rubocop-1.68.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.67.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.66.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.66.0 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.65.1 lib/rubocop/cop/lint/empty_file.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.65.0 lib/rubocop/cop/lint/empty_file.rb
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/empty_file.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/empty_file.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/empty_file.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-1.64.1/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.64.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.63.4 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.63.3 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.63.2 lib/rubocop/cop/lint/empty_file.rb
harbr-2.8.1 vendor/bundle/ruby/3.2.0/gems/rubocop-1.57.2/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.63.1 lib/rubocop/cop/lint/empty_file.rb
rubocop-1.63.0 lib/rubocop/cop/lint/empty_file.rb
bison-0.1.0 vendor/bundle/ruby/3.2.0/gems/rubocop-1.62.1/lib/rubocop/cop/lint/empty_file.rb
rubocop-1.62.1 lib/rubocop/cop/lint/empty_file.rb