Contents

module Take
  module Lint

    # Manages linting source files when building.  Should be
    # interesting to see how this pans out.
    #
    # @abstract
    class Base

      # Initializes the base linter.  Requires only one parameter.
      #
      # @param file [Path] the file that will be linted.
      def initialize(file)
        @file = file
      end

      # Lints the given file.  Returns an array of lint errors, which
      # is used to give information about what could be fixed.
      #
      # @abstract
      # @return [Array<Take::Lint::Error>]
      def lint
        raise NotImplementedError
      end

    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
take-0.0.15	lib/take/lint/base.rb
take-0.0.14	lib/take/lint/base.rb
take-0.0.13	lib/take/lint/base.rb
take-0.0.12	lib/take/lint/base.rb
take-0.0.11	lib/take/lint/base.rb