Package org.sonar.plugins.javascript.api

Interface EslintBasedCheck

All Superinterfaces:

JavaScriptCheck

public interface EslintBasedCheck
extends JavaScriptCheck

Method Summary

Modifier and Type	Method	Description
default PreciseIssue	addIssue(Tree tree, String message)	Returns new issue which is instance of PreciseIssue.
default <T extends Issue> T	addIssue(T issue)	Use this method only to add specific kind of issue.
default LineIssue	addLineIssue(Tree tree, String message)	Returns new issue which is located on first line of tree
default List<Object>	configurations()
String	eslintKey()
default List<Issue>	scanFile(TreeVisitorContext context)

Method Detail

eslintKey

String eslintKey()

configurations

default List<Object> configurations()

scanFile

default List<Issue> scanFile(TreeVisitorContext context)

Specified by:

scanFile in interface JavaScriptCheck

addLineIssue

default LineIssue addLineIssue(Tree tree,
                               String message)

Description copied from interface: JavaScriptCheck

Returns new issue which is located on first line of tree

Specified by:

addLineIssue in interface JavaScriptCheck

addIssue

default PreciseIssue addIssue(Tree tree,
                              String message)

Description copied from interface: JavaScriptCheck

Returns new issue which is instance of PreciseIssue. Then you can chain this method with following method calls to provide more information about issue:

• PreciseIssue.secondary(Tree, String), PreciseIssue.secondary(Tree) (without message) or PreciseIssue.secondary(IssueLocation) to add secondary location
• PreciseIssue.cost(double) to add cost

See example

 
  newIssue(functionDeclaration, "Remove this function declaration")
    .secondary(call, "Function call")
    .secondary(redefinition, "Function redefinition")
    .cost(functionDeclaration.parameters().parameters().size());
 
 

To create new issue you also can use JavaScriptCheck.addIssue(Issue):

getContext().addIssue(new FileIssue(this, "Some message"))

Specified by:

addIssue in interface JavaScriptCheck

Parameters:

tree - primary location of issue

message - primary message

Returns:

new issue

addIssue

default <T extends Issue> T addIssue(T issue)

Description copied from interface: JavaScriptCheck

Use this method only to add specific kind of issue. E.g. you can use this method to add issue on file level, line issue or precise issue with sophisticated primary location.

Otherwise please use JavaScriptCheck.addIssue(Tree, String)

Specified by:

addIssue in interface JavaScriptCheck