org.sonar.plugins.javascript.api

Interface JavaScriptCheck

All Known Implementing Classes:

DoubleDispatchVisitorCheck, SubscriptionVisitorCheck

@Beta
public interface JavaScriptCheck

Marker interface for all JavaScript checks.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Issue> T	addIssue(T issue) Use this method only to add specific kind of issue (when listed below methods don't meet your needs).
PreciseIssue	addIssue(Tree tree, String message) Returns new issue which is instance of PreciseIssue.
LineIssue	addLineIssue(Tree tree, String message) This method should be deprecated, as soon as this plugin will be migrated on 5.X LTS (with support of precise issue locations).
TreeVisitorContext	getContext()
List<Issue>	scanFile(TreeVisitorContext context)

Method Detail

getContext

TreeVisitorContext getContext()

addLineIssue

LineIssue addLineIssue(Tree tree,
                     String message)

This method should be deprecated, as soon as this plugin will be migrated on 5.X LTS (with support of precise issue locations).

Instead please use addIssue(Tree, String)

addIssue

PreciseIssue addIssue(Tree tree,
                    String message)

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 addIssue(Issue):

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

Parameters:

tree - primary location of issue

message - primary message

Returns:

new issue

addIssue

<T extends Issue> T addIssue(T issue)

Use this method only to add specific kind of issue (when listed below methods don't meet your needs). E.g. you can use this method to add issue on file level, line issue knowing only line number (i.e. not having tree instance) or precise issue with sophisticated primary location.

Otherwise please use:

• addIssue(Tree, String) for precise issue (see PreciseIssue)
• addLineIssue(Tree, String) for line issue (see LineIssue)

scanFile

List<Issue> scanFile(TreeVisitorContext context)