hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

[doc] Improve DeadLinksChecker

Browse Source 
A leading slash is a problem now. Links need to be relative.
This commit is contained in:
Andreas Dangel
2019-07-06 12:00:33 +02:00
parent 6cb0701498
commit b691cec6a4
1 changed files with 18 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
pmd-doc/src/main/java/net/sourceforge/pmd/docs/DeadLinksChecker.java
View File

@@ -30,6 +30,7 @@ import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.FutureTask;
import java.util.concurrent.RunnableFuture;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
@@ -79,7 +80,7 @@ public class DeadLinksChecker {
final Path pagesDirectory = rootDirectory.resolve("docs/pages");
if (!Files.isDirectory(pagesDirectory)) {
LOG.warning("can't check for dead links, didn't find \"pages\" directory at: " + pagesDirectory);
LOG.severe("can't check for dead links, didn't find \"pages\" directory at: " + pagesDirectory);
System.exit(1);
}
@@ -110,10 +111,13 @@ public class DeadLinksChecker {
linkCheck:
while (matcher.find()) {
final String linkText = matcher.group();
final String linkTarget = matcher.group(1).replaceAll("^/+", ""); // remove the leading "/"
final String linkTarget = matcher.group(1);
boolean linkOk;
if (linkTarget.startsWith(LOCAL_FILE_PREFIX)) {
if (linkTarget.charAt(0) == '/') {
// links must never start with / - they must be relative or start with https?//...
linkOk = false;
} else if (linkTarget.startsWith(LOCAL_FILE_PREFIX)) {
String localLinkPart = linkTarget.substring(LOCAL_FILE_PREFIX.length());
if (localLinkPart.contains("#")) {
localLinkPart = localLinkPart.substring(0, localLinkPart.indexOf('#'));
@@ -168,7 +172,11 @@ public class DeadLinksChecker {
}
if (!linkOk) {
addDeadLink(fileToDeadLinks, mdFile, new FutureTask<>(() -> String.format("%8d: %s", lineNo, linkText)));
RunnableFuture<String> futureTask = new FutureTask<>(() -> String.format("%8d: %s", lineNo, linkText));
// execute this task immediately in this thread.
// External links are checked by another executor and don't end up here.
futureTask.run();
addDeadLink(fileToDeadLinks, mdFile, futureTask);
}
}
}
@@ -322,6 +330,12 @@ public class DeadLinksChecker {
public static void main(String[] args) throws IOException {
if (args.length != 1) {
System.err.println("Wrong arguments!");
System.err.println();
System.err.println("java " + DeadLinksChecker.class.getSimpleName() + " <project base directory>");
System.exit(1);
}
final Path rootDirectory = Paths.get(args[0]).resolve("..").toRealPath();
DeadLinksChecker deadLinksChecker = new DeadLinksChecker();