MarkdownCheck improvements (#432)

Author: wborn

custom-checks/checkstyle/src/main/java/org/openhab/tools/analysis/checkstyle/readme/MarkdownCheck.java

@@ -16,8 +16,6 @@
 
 import java.io.File;
 
-import org.eclipse.pde.core.build.IBuild;
-import org.eclipse.pde.core.build.IBuildEntry;
 import org.openhab.tools.analysis.checkstyle.api.AbstractStaticCheck;
 
 import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
@@ -34,53 +32,26 @@
  * <li>missing empty lines before and after lists.
  * </ul>
  *
- * Checks the build.properties for:
- * <ul>
- * <li>the README.MD shouldn't be added in build.properties.
- * <li>the doc folder shouldn't be added in build.properties.
- * </ul>
  * <a href="https://www.openhab.org/docs/developer/guidelines.html">openHAB Coding Guidelines</a>
  *
  * @author Erdoan Hadzhiyusein - Initial contribution
  * @author Lyubomir Papazov - Change the Markdown parser to flexmark
  */
 public class MarkdownCheck extends AbstractStaticCheck {
-    private static final String ADDED_README_FILE_IN_BUILD_PROPERTIES_MSG = "README.MD file must not be added to the bin.includes property";
-    private static final String ADDED_DOC_FOLDER_IN_BUILD_PROPERTIES_MSG = "The doc folder must not be added to the bin.includes property";
-    private static final String DOC_FOLDER_NAME = "doc";
 
     public MarkdownCheck() {
-        setFileExtensions(MARKDONW_EXTENSION, PROPERTIES_EXTENSION);
+        setFileExtensions(MARKDONW_EXTENSION);
     }
 
     @Override
     protected void processFiltered(File file, FileText fileText) throws CheckstyleException {
         switch (file.getName()) {
-            case BUILD_PROPERTIES_FILE_NAME:
-                checkBuildProperties(fileText);
-                break;
             case README_MD_FILE_NAME:
                 checkReadMe(fileText);
                 break;
         }
     }
 
-    private void checkBuildProperties(FileText fileText) throws CheckstyleException {
-        // The check will not log an errors if build properties file is missing
-        // We have other check regarding this case - RequiredFilesCheck
-        IBuild buildPropertiesEntry = parseBuildProperties(fileText);
-        boolean isReadMeIncluded = checkBuildPropertiesEntry(buildPropertiesEntry, BIN_INCLUDES_PROPERTY_NAME,
-                README_MD_FILE_NAME);
-        if (isReadMeIncluded) {
-            log(0, ADDED_README_FILE_IN_BUILD_PROPERTIES_MSG);
-        }
-        boolean isDocFolderIncluded = checkBuildPropertiesEntry(buildPropertiesEntry, BIN_INCLUDES_PROPERTY_NAME,
-                DOC_FOLDER_NAME);
-        if (isDocFolderIncluded) {
-            log(0, ADDED_DOC_FOLDER_IN_BUILD_PROPERTIES_MSG);
-        }
-    }
-
     private void checkReadMe(FileText fileText) {
         MutableDataSet options = new MutableDataSet();
         // By setting this option to true, the parser provides line numbers in the original markdown text for each node
@@ -97,13 +68,4 @@ public void log(int line, String message) {
         MarkdownVisitor visitor = new MarkdownVisitor(callBack, fileText);
         visitor.visit(readmeMarkdownNode);
     }
-
-    /**
-     * Checks whether the given value is added in the build.properties file.
-     */
-    private boolean checkBuildPropertiesEntry(IBuild buildPropertiesFile, String property, String value)
-            throws CheckstyleException {
-        IBuildEntry binIncludes = buildPropertiesFile.getEntry(property);
-        return binIncludes != null && binIncludes.contains(value);
-    }
 }

custom-checks/checkstyle/src/main/java/org/openhab/tools/analysis/checkstyle/readme/MarkdownVisitor.java

@@ -147,8 +147,13 @@ private void checkEmptyLineAfterList(ListBlock listBlock) {
         if (isListEnd) {
             String[] lastListItemlines = lastListItemContent.getChars().toString().split(REGEX_NEW_LINES);
             if (lastListItemlines.length > 1) {
-                // Log the one-based line where there is an empty line
-                callback.log(lastListItemContent.getLineNumber(), EMPTY_LINE_AFTER_LIST_MSG);
+                for (int i = 1; i < lastListItemlines.length; i++) {
+                    if (!lastListItemlines[i].startsWith(" ")) {
+                        // Log the one-based line where there is an empty line
+                        callback.log(lastListItemContent.getLineNumber(), EMPTY_LINE_AFTER_LIST_MSG);
+                        break;
+                    }
+                }
             }
         }
     }

custom-checks/checkstyle/src/test/java/org/openhab/tools/analysis/checkstyle/test/MarkdownCheckTest.java

@@ -16,7 +16,6 @@
 import static org.openhab.tools.analysis.checkstyle.api.CheckConstants.README_MD_FILE_NAME;
 
 import java.io.File;
-import java.io.IOException;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -32,8 +31,6 @@
  * @author Lyubomir Papazov - Added more tests
  */
 public class MarkdownCheckTest extends AbstractStaticCheckTest {
-    private static final String ADDED_README_IN_BUILD_PROPERTIES_MSG = "README.MD file must not be added to the bin.includes property";
-    private static final String ADDED_DOC_FOLDER_IN_BUILD_PROPERTIES_MSG = "The doc folder must not be added to the bin.includes property";
     private DefaultConfiguration config;
 
     @BeforeEach
@@ -86,6 +83,11 @@ public void testEmptyLineAfterList() throws Exception {
         verifyMarkDownFile("testEmptyLineAfterList", expectedMessages);
     }
 
+    @Test
+    public void testListWithParagraphs() throws Exception {
+        verifyMarkDownFile("testListWithParagraphs", noMessagesExpected());
+    }
+
     @Test
     public void testListAtEndOfFile() throws Exception {
         verifyMarkDownFile("testListAtEndOfFile", noMessagesExpected());
@@ -225,40 +227,6 @@ public void testLinkAsHeader() throws Exception {
         verifyMarkDownFile("testLinkAsHeader", noMessagesExpected());
     }
 
-    @Test
-    public void testReadMeAddedInBuildProperties() throws Exception {
-        String[] expectedMessages = generateExpectedMessages(0, ADDED_README_IN_BUILD_PROPERTIES_MSG);
-        String testDirectoryName = "testAddedReadMeInBuildProperties";
-
-        // The message is logged for the build.properties file
-        verifyBuildProperties(expectedMessages, testDirectoryName);
-    }
-
-    @Test
-    public void testAddedDummyDocInBuildProperties() throws Exception {
-        String testDirectoryName = "testAddedDummyDocInBuildProperties";
-        verifyBuildProperties(noMessagesExpected(), testDirectoryName);
-    }
-
-    @Test
-    public void testDocFolderAddedInBuildProperties() throws Exception {
-        String[] expectedMessages = generateExpectedMessages(0, ADDED_DOC_FOLDER_IN_BUILD_PROPERTIES_MSG);
-        String testDirectoryName = "testAddedDocFolderInBuildProperties";
-
-        // The message is logged for the build.properties file
-        verifyBuildProperties(expectedMessages, testDirectoryName);
-    }
-
-    @Test
-    public void testAddedReadmeAndDocInBuildProperties() throws Exception {
-        String[] expectedMessages = generateExpectedMessages(0, ADDED_README_IN_BUILD_PROPERTIES_MSG, 0,
-                ADDED_DOC_FOLDER_IN_BUILD_PROPERTIES_MSG);
-        String testDirectoryName = "testAddedReadmeAndDocInBuildProperties";
-
-        // The message is logged for the build.properties file
-        verifyBuildProperties(expectedMessages, testDirectoryName);
-    }
-
     @Test
     public void testOpenhabBindingExec() throws Exception {
         String testDirectoryName = "org.openhab.binding.exec";
@@ -281,13 +249,6 @@ public void testDocFolderWrong() throws Exception {
         verifyMarkDownFile("testDocFolderWrong", expectedMessages);
     }
 
-    private void verifyBuildProperties(String[] expectedMessages, String testDirectoryName)
-            throws IOException, Exception {
-        String testDirectoryAbsolutePath = getPath(testDirectoryName);
-        String messageFilePath = testDirectoryAbsolutePath + File.separator + "build.properties";
-        verify(createChecker(config), messageFilePath, expectedMessages);
-    }
-
     private void createValidConfig() {
         config = createModuleConfig(MarkdownCheck.class);
     }