CheckStyle: configure SuppressWithNearbyCommentFilter to allow special comments before the line.

No code changes.

Author: php-coder

src/main/config/checkstyle-suppressions.xml

@@ -5,15 +5,6 @@
 
 <suppressions>
 
-	<suppress checks="LineLength" files="AbstractPage.java" lines="44,45" />
-	<suppress checks="LineLength" files="AbstractPageWithForm.java" lines="27,28,33" />
-	<suppress checks="LineLength" files="Form.java" lines="31,32,37" />
-	<suppress checks="LineLength" files="Url.java" lines="77,78,79" />
-	<suppress checks="LineLength" files="ErrorController.java" lines="73" />
-	<suppress checks="LineLength" files="SecurityConfig.java" lines="31,32,36" />
-	<suppress checks="LineLength" files="JdbcSeriesDaoImpl.java" lines="123" />
-	<suppress checks="LineLength" files="TestObjects.java" lines="52" />
-	
 	<!-- false positives due to Lombok usage -->
 	<suppress checks="HideUtilityClassConstructor" files="ru.mystamps.web.model" />
 	<suppress checks="HideUtilityClassConstructor" files="ru.mystamps.web.entity" />

src/main/config/checkstyle.xml

@@ -75,9 +75,9 @@
     </module>
 
     <module name="SuppressWithNearbyCommentFilter">
-        <property name="commentFormat" value="NOCHECKSTYLE"/>
-        <property name="checkFormat" value=".*"/>
-        <property name="influenceFormat" value="0"/>
+        <property name="commentFormat" value="CheckStyle: ignore (\w+) for next (\d+) line"/>
+        <property name="checkFormat" value="$1"/>
+        <property name="influenceFormat" value="$2"/>
     </module>
 
     <!-- Allow to use @SuppressWarning annotation to suppress warnings -->
@@ -263,7 +263,7 @@
         -->
         <module name="UpperEll"/>
         <module name="TrailingComment">
-            <property name="legalComment" value="TODO|XXX|NOPMD|NOCHECKSTYLE"/>
+            <property name="legalComment" value="TODO|XXX|NOPMD"/>
         </module>
 
     </module>

src/main/java/ru/mystamps/web/Url.java

@@ -74,6 +74,7 @@ public final class Url {
 	public static final String JQUERY_JS              = "/public/jquery/jquery.min.js";
 
 	// see also pom.xml and ru.mystamps.web.config.MvcConfig#addResourceHandlers()
+	// CheckStyle: ignore LineLength for next 3 lines
 	public static final String BOOTSTRAP_CSS_CDN     = "http://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css";
 	public static final String BOOTSTRAP_JS_CDN      = "http://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/js/bootstrap.min.js";
 	public static final String JQUERY_JS_CDN         = "http://yandex.st/jquery/1.9.1/jquery.min.js";

src/main/java/ru/mystamps/web/config/ControllersConfig.java

@@ -23,7 +23,8 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
-import ru.mystamps.web.controller.*; // NOCHECKSTYLE: AvoidStarImportCheck, NOPMD: UnusedImports
+// CheckStyle: ignore AvoidStarImportCheck for next 1 line
+import ru.mystamps.web.controller.*; // NOPMD: UnusedImports
 
 @Configuration
 public class ControllersConfig {

src/main/java/ru/mystamps/web/config/ServicesConfig.java

@@ -25,8 +25,9 @@
 import org.springframework.core.env.Environment;
 import org.springframework.mail.javamail.JavaMailSender;
 
-import ru.mystamps.web.dao.*; // NOCHECKSTYLE: AvoidStarImportCheck, NOPMD: UnusedImports
-import ru.mystamps.web.service.*; // NOCHECKSTYLE: AvoidStarImportCheck, NOPMD: UnusedImports
+// CheckStyle: ignore AvoidStarImportCheck for next 2 lines
+import ru.mystamps.web.dao.*; // NOPMD: UnusedImports
+import ru.mystamps.web.service.*; // NOPMD: UnusedImports
 import ru.mystamps.web.support.spring.security.SecurityConfig;
 
 @Configuration

src/main/java/ru/mystamps/web/controller/ErrorController.java

@@ -69,9 +69,10 @@ public void notFound(
 	public void internalError(HttpServletRequest request) {
 		// TODO: log to database (with *.status_code, *.message, *.servlet_name and user details)
 
-		String page            = (String)request.getAttribute("javax.servlet.error.request_uri");
+		// CheckStyle: ignore LineLength for next 1 line
 		Class<?> exceptionType = (Class<?>)request.getAttribute("javax.servlet.error.exception_type");
 		Exception exception    = (Exception)request.getAttribute("javax.servlet.error.exception");
+		String page            = (String)request.getAttribute("javax.servlet.error.request_uri");
 
 		if (page != null && !Url.INTERNAL_ERROR_PAGE.equals(page)) {
 			String msg = String.format(

src/main/java/ru/mystamps/web/dao/impl/JdbcSeriesDaoImpl.java

@@ -120,6 +120,7 @@ public Iterable<SeriesInfoDto> findByCountryIdAsSeriesInfo(Integer countryId, St
 	}
 
 	@Override
+	// CheckStyle: ignore LineLength for next 1 line
 	public Iterable<SeriesInfoDto> findByCollectionIdAsSeriesInfo(Integer collectionId, String lang) {
 		Map<String, Object> params = new HashMap<>();
 		params.put("collection_id", collectionId);

src/main/java/ru/mystamps/web/support/spring/security/SecurityConfig.java

@@ -28,11 +28,13 @@
 import org.springframework.security.authentication.AuthenticationProvider;
 import org.springframework.security.authentication.dao.DaoAuthenticationProvider;
 import org.springframework.security.authentication.event.AuthenticationFailureBadCredentialsEvent;
+// CheckStyle: ignore LineLength for next 2 lines
 import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
 import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity;
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.config.annotation.web.builders.WebSecurity;
 import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+// CheckStyle: ignore LineLength for next 1 line
 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 import org.springframework.security.core.userdetails.UserDetailsService;
 import org.springframework.security.crypto.password.PasswordEncoder;

src/test/java/ru/mystamps/web/service/TestObjects.java

@@ -49,6 +49,7 @@ final class TestObjects {
 
 	private static final String TEST_NAME           = "Test Name";
 	private static final String TEST_LOGIN          = "test";
+	// CheckStyle: ignore LineLength for next 1 line
 	private static final String TEST_HASH           = "$2a$10$Oo8A/oaKQYwt4Zi1RWGir.HHziCG267CJaqaNaNUtE/8ceysZn0za";
 
 	private TestObjects() {

src/test/java/ru/mystamps/web/tests/page/AbstractPage.java

@@ -40,9 +40,10 @@
 @RequiredArgsConstructor(access = PROTECTED)
 public abstract class AbstractPage {
 
-	private static final String A_HREF_LOCATOR = "//a[@href=\"%s\"]";
+	// CheckStyle: ignore LineLength for next 2 lines
 	private static final String LOGOUT_BUTTON_LOCATOR = "//form[@id=\"LogoutForm\"]/input[@type=\"submit\"]";
 	private static final String USER_BAR_ENTRIES_LOCATOR = "//*[@id=\"user_bar\"]//li/a | //*[@id=\"user_bar\"]//li//input[not(@type=\"hidden\")]";
+	private static final String A_HREF_LOCATOR = "//a[@href=\"%s\"]";
 
 	protected final WebDriver driver;
 	private final String pageUrl;

src/test/java/ru/mystamps/web/tests/page/AbstractPageWithForm.java

@@ -34,6 +34,7 @@
 
 public abstract class AbstractPageWithForm extends AbstractPage {
 
+	// CheckStyle: ignore LineLength for next 1 line
 	private static final String          LABEL_LOCATOR = "//label[@for=\"%s\"]/span[@class=\"field-label\"]";
 	private static final String    FIELD_ERROR_LOCATOR = "//span[@id=\"%s.errors\"]";
 	private static final String FIELD_REQUIRED_LOCATOR = "//span[@id=\"%s.required\"]";

src/test/java/ru/mystamps/web/tests/page/element/Form.java

@@ -28,12 +28,14 @@
 public final class Form {
 	private static final String              FORM_LOCATOR = "//form";
 	private static final String       INPUT_FIELD_LOCATOR = "//input[@name=\"%s\"]";
+	// CheckStyle: ignore LineLength for next 2 lines
 	private static final String    PASSWORD_FIELD_LOCATOR = "//input[@name=\"%s\"][@type=\"password\"]";
 	private static final String    CHECKBOX_FIELD_LOCATOR = "//input[@name=\"%s\"][@type=\"checkbox\"]";
 	private static final String      UPLOAD_FIELD_LOCATOR = "//input[@name=\"%s\"][@type=\"file\"]";
 	private static final String      SELECT_FIELD_LOCATOR = "//select[@name=\"%s\"]";
 	private static final String    TEXTAREA_FIELD_LOCATOR = "//textarea[@name=\"%s\"]";
 	private static final String     SUBMIT_BUTTON_LOCATOR = "//input[@type=\"submit\"]";
+	// CheckStyle: ignore LineLength for next 1 line
 	private static final String SUBMIT_WITH_VALUE_LOCATOR = "//input[@type=\"submit\"][@value=\"%s\"]";
 
 	@Getter private List<Field> fields;