Class LintPackagesMojo

java.lang.Object
network.ike.docs.plugin.LintPackagesMojo
All Implemented Interfaces:
org.apache.maven.api.plugin.Mojo

@Mojo(name="lint-packages", defaultPhase="validate") public class LintPackagesMojo extends Object implements org.apache.maven.api.plugin.Mojo
Lint a topic library laid out as packages (dev-adoc-packages, IKE-Network/ike-issues#1341) and fail the build with every finding listed: the root holds only dotted-group directories and META-INF; every package begins with the module's own group unless the POM property ike.adoc.packages declares another prefix on purpose; a topic's directory equals the domain prefix of its :topic-id:; images are inside packages, not at the root. An include or image line that still uses the {topics} alias is a warning naming the file and line. The rules are PackageLint's; this goal is the wiring.

Gated by the POM property ike.adoc.layout=packages: a library without it is skipped, so the layout before packages keeps building unchanged. Runs at validate. Skip with -Dike.skip.lint-packages=true.

Since:
136
  • Constructor Details

    • LintPackagesMojo

      public LintPackagesMojo()
      Creates this goal instance.
  • Method Details

    • getLog

      protected org.apache.maven.api.plugin.Log getLog()
      Access the Maven logger.
      Returns:
      the logger
    • execute

      public void execute() throws org.apache.maven.api.plugin.MojoException
      Specified by:
      execute in interface org.apache.maven.api.plugin.Mojo
      Throws:
      org.apache.maven.api.plugin.MojoException