org.sonar.javascript.checks.verifier

Class JavaScriptCheckVerifier

java.lang.Object

org.sonar.javascript.checks.verifier.JavaScriptCheckVerifier

public class JavaScriptCheckVerifier
extends Object

Method Summary

Modifier and Type	Method and Description
static org.sonar.squidbridge.checks.CheckMessagesVerifier	issues(JavaScriptCheck check, File file) Example:
static void	verify(JavaScriptCheck check, File file) To use this message you should provide a comment on each line of the source file where you expect an issue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

issues

public static org.sonar.squidbridge.checks.CheckMessagesVerifier issues(JavaScriptCheck check,
                                                                        File file)

Example:

 JavaScriptCheckVerifier.issues(new MyCheck(), myFile))
    .next().atLine(2).withMessage("This is message for line 2.")
    .next().atLine(3).withMessage("This is message for line 3.").withCost(2.)
    .next().atLine(8)
    .noMore();
 

verify

public static void verify(JavaScriptCheck check,
                          File file)

To use this message you should provide a comment on each line of the source file where you expect an issue. For example:

 var x = 1; // Noncompliant {{A message for this line.}}

 function foo() {  // Noncompliant [[effortToFix=2]] [[secondary=+0,+1]] [[sc=5;ec=6;el=+0]]
 }
 

How to write these comments:

• Put a comment starting with "Noncompliant" if you expect an issue on this line.
• If for some reason you can't put comment on a line with issue, put "@+N" just after "Noncompliant" for issue located N lines after the one with comment
• In double curly braces {{MESSAGE}} provide expected message.
• In double brackets provide expected effort to fix (cost) with effortToFix keyword.
• In double brackets provide precise location description with sc, ec, el keywords respectively for start column, end column and end line.
• Since version 2.13 to specify precise location you can provide separate comment on next line which contains symbol ^ under each character of issue location.

 x = a && a;  // Noncompliant
 //    ^^
 

• Since version 2.15 to specify precise secondary location you can provide separate comment on next line which contains symbol ^ under each character of secondary issue location. Start comment with "S" symbol and put after "^" ID of issue (specify it in double square brackets). You can optionally provide message of secondary location.

 x = a && a;  // Noncompliant [[id=SomeID]]
 //S   ^^ SomeID {{secondary message}}
 

• In double brackets provide secondary locations with secondary keyword.
• To specify the line you can use relative location by putting + or -.
• All listed elements are optional (except "Noncompliant").

Example of call:

 JavaScriptCheckVerifier.verify(new MyCheck(), myFile));