Inheritance diagram for webkitpy.style.checker.StyleProcessorConfiguration:

Public Member Functions
def	__init__ (self, filter_configuration, max_reports_per_category, min_confidence, output_format, commit_queue)

def	is_reportable (self, category, confidence_in_error, file_path)

def	write_style_error (self, category, confidence_in_error, file_path, line_number, message)

Public Attributes
	max_reports_per_category

	min_confidence

	commit_queue

Detailed Description

Stores configuration values for the StyleProcessor class.

Attributes:
  min_confidence: An integer between 1 and 5 inclusive that is the
                  minimum confidence level of style errors to report.

  max_reports_per_category: The maximum number of errors to report
                            per category, per file.

Constructor & Destructor Documentation

◆ init()

def webkitpy.style.checker.StyleProcessorConfiguration.__init__	(	self,
		filter_configuration,
		max_reports_per_category,
		min_confidence,
		output_format,
		commit_queue
	)

Create a StyleProcessorConfiguration instance.

Args:
  filter_configuration: A FilterConfiguration instance.  The default
                is the "empty" filter configuration, which
                means that all errors should be checked.

  max_reports_per_category: The maximum number of errors to report
                    per category, per file.

  min_confidence: An integer between 1 and 5 inclusive that is the
          minimum confidence level of style errors to report.
          The default is 1, which reports all style errors.

  output_format: A string that is the output format.  The supported
         output formats are "emacs" which emacs can parse
         and "vs7" which Microsoft Visual Studio 7 can parse.

  commit_queue: A bool indicating whether the style check is performed
        by the commit queue or not.

Member Function Documentation

◆ is_reportable()

def webkitpy.style.checker.StyleProcessorConfiguration.is_reportable	(	self,
		category,
		confidence_in_error,
		file_path
	)

Return whether an error is reportable.

An error is reportable if both the confidence in the error is
at least the minimum confidence level and the current filter
says the category should be checked for the given path.

Args:
  category: A string that is a style category.
  confidence_in_error: An integer between 1 and 5 inclusive that is
               the application's confidence in the error.
               A higher number means greater confidence.
  file_path: The path of the file being checked

◆ write_style_error()

def webkitpy.style.checker.StyleProcessorConfiguration.write_style_error	(	self,
		category,
		confidence_in_error,
		file_path,
		line_number,
		message
	)

Write a style error to the configured stderr.

Member Data Documentation

◆ commit_queue

webkitpy.style.checker.StyleProcessorConfiguration.commit_queue

◆ max_reports_per_category

webkitpy.style.checker.StyleProcessorConfiguration.max_reports_per_category

◆ min_confidence

webkitpy.style.checker.StyleProcessorConfiguration.min_confidence

The documentation for this class was generated from the following file:

Tools/Scripts/webkitpy/style/checker.py

Public Member Functions

Public Attributes