io.github.md2conf.maven.plugin.AbstractMd2ConfMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of md2conf-maven-plugin Show documentation
The newest version!
package io.github.md2conf.maven.plugin;

import com.vladsch.flexmark.util.format.options.HeadingStyle;
import io.github.md2conf.command.ConvertCommand;
import io.github.md2conf.command.IndexCommand;
import io.github.md2conf.command.PublishCommand;
import io.github.md2conf.command.subcommand.Md2WikiConvertCommand;
import io.github.md2conf.command.subcommand.View2MdConvertCommand;
import io.github.md2conf.confluence.client.OrphanRemovalStrategy;
import io.github.md2conf.confluence.client.PublishingStrategy;
import io.github.md2conf.indexer.ChildLayout;
import io.github.md2conf.indexer.OrphanFileAction;
import io.github.md2conf.title.processor.TitleExtractStrategy;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.nio.file.Path;

public abstract class AbstractMd2ConfMojo extends AbstractMojo {

    static final String PREFIX = "md2conf.";

    @Parameter(property = PREFIX + "skip", defaultValue = "false")
    protected boolean skip;

    @Parameter(property = PREFIX + "outputDirectory", defaultValue = "${project.build.directory}/md2conf", readonly = true)
    protected File outputDirectory;

    /// --- CONVERT options

    @Parameter(property = PREFIX + "inputDirectory")
    protected File inputDirectory;
    @Parameter(property = PREFIX + "indexerFileExtension")
    protected String indexerFileExtension = "md";
    @Parameter(property = PREFIX + "indexerExcludePattern")
    protected String indexerExcludePattern = "glob:**/.*";
    @Parameter(property = PREFIX + "indexerRootPage")
    protected String indexerRootPage = null;
    @Parameter(property = PREFIX + "indexerChildLayout")
    protected ChildLayout indexerChildLayout = ChildLayout.SUB_DIRECTORY;
    @Parameter(property = PREFIX + "orphanFileAction")
    protected OrphanFileAction orphanFileAction = OrphanFileAction.IGNORE;
    @Parameter(property = PREFIX + "titleExtract")
    protected TitleExtractStrategy titleExtract = TitleExtractStrategy.FROM_FIRST_HEADER;
    @Parameter(property = PREFIX + "titlePrefix")
    protected String titlePrefix;
    @Parameter(property = PREFIX + "titleSuffix")
    protected String titleSuffix;
    @Parameter(property = PREFIX + "titleChildPrefixed")
    protected boolean titleChildPrefixed;
    @Parameter(property = PREFIX + "titleRemoveFromContent")
    protected Boolean titleRemoveFromContent;
    @Parameter(property = PREFIX + "plantumlCodeMacroEnable")
    protected Boolean plantumlCodeMacroEnable=false;
    @Parameter(property = PREFIX + "plantumlCodeMacroName")
    protected String plantumlCodeMacroName;
    @Parameter(property = PREFIX + "markdownRightMargin")
    protected Integer markdownRightMargin;
    @Parameter(property = PREFIX + "markdownHeadingStyle")
    protected HeadingStyle markdownHeadingStyle;

    /// --- PUBLISH options

    @Parameter(property = PREFIX + "confluenceUrl")
    protected String confluenceUrl;
    @Parameter(property = PREFIX + "username")
    protected String username;
    @Parameter(property = PREFIX + "password")
    protected String password;
    @Parameter(property = PREFIX + "spaceKey")
    protected String spaceKey;
    @Parameter(property = PREFIX + "parentPageTitle")
    protected String parentPageTitle;
    @Parameter(property = PREFIX + "confluenceContentModelPath")
    protected File confluenceContentModelPath;
    @Parameter(property = PREFIX + "versionMessage")
    protected String versionMessage = "Published by md2conf";
    @Parameter(property = PREFIX + "orphanRemovalStrategy")
    protected OrphanRemovalStrategy orphanRemovalStrategy = OrphanRemovalStrategy.KEEP_ORPHANS;
    @Parameter(property = PREFIX + "parentPagePublishingStrategy")
    protected PublishingStrategy parentPagePublishingStrategy = PublishingStrategy.APPEND_TO_ANCESTOR;
    @Parameter(property = PREFIX + "notifyWatchers")
    protected boolean notifyWatchers = false;
    @Parameter(property = PREFIX + "skipSslVerification")
    protected boolean skipSslVerification = false;
    @Parameter(property = PREFIX + "maxRequestsPerSecond")
    protected Double maxRequestsPerSecond;
    @Parameter(property = PREFIX + "connectionTimeToLive")
    protected Integer connectionTimeToLive;


    @NotNull
    protected Md2WikiConvertCommand.Md2WikiConvertOptions getMd2WikiConvertOptions() {
        Md2WikiConvertCommand.Md2WikiConvertOptions md2WikiConvertOptions = new Md2WikiConvertCommand.Md2WikiConvertOptions();
        md2WikiConvertOptions.outputDirectory = this.outputDirectory.toPath();
        md2WikiConvertOptions.plantumlCodeMacroEnable = this.plantumlCodeMacroEnable;
        md2WikiConvertOptions.plantumlCodeMacroName = this.plantumlCodeMacroName;
        return md2WikiConvertOptions;
    }

    @NotNull
    protected ConvertCommand.TitleProcessingOptions getTitleProcessingOptions() {
        ConvertCommand.TitleProcessingOptions titleProcessingOptions = new ConvertCommand.TitleProcessingOptions();
        titleProcessingOptions.titleExtract = this.titleExtract;
        titleProcessingOptions.titlePrefix = this.titlePrefix;
        titleProcessingOptions.titleSuffix = this.titleSuffix;
        titleProcessingOptions.titleChildPrefixed = this.titleChildPrefixed;
        titleProcessingOptions.titleRemoveFromContent = this.titleRemoveFromContent;
        return titleProcessingOptions;
    }

    @NotNull
    protected View2MdConvertCommand.View2MdConvertOptions getFormatOptions() {
        View2MdConvertCommand.View2MdConvertOptions view2MdConvertOptions = new View2MdConvertCommand.View2MdConvertOptions();
        view2MdConvertOptions.modelPath = this.confluenceContentModelPath.toPath();
        return view2MdConvertOptions;
    }

    protected View2MdConvertCommand.MarkdownFormatOptions getMarkdownFormatOptions() {
        View2MdConvertCommand.MarkdownFormatOptions markdownFormatOptions = new View2MdConvertCommand.MarkdownFormatOptions();
        markdownFormatOptions.markdownHeadingStyle = this.markdownHeadingStyle;
        markdownFormatOptions.markdownRightMargin = this.markdownRightMargin;
        return markdownFormatOptions;
    }

    protected IndexCommand.IndexerOptions getIndexerOptions(){
        IndexCommand.IndexerOptions indexerOptions = new IndexCommand.IndexerOptions();
        indexerOptions.inputDirectory = this.inputDirectory.toPath();
        indexerOptions.indexerFileExtension = this.indexerFileExtension;
        indexerOptions.indexerExcludePattern = this.indexerExcludePattern;
        indexerOptions.indexerRootPage = this.indexerRootPage;
        indexerOptions.indexerChildLayout = this.indexerChildLayout;
        indexerOptions.indexerOrphanFileAction = this.orphanFileAction;
        return indexerOptions;
    }

    @NotNull
    protected PublishCommand.PublishOptions getPublishOptions() {
        PublishCommand.PublishOptions options = new PublishCommand.PublishOptions();
        options.versionMessage = this.versionMessage;
        options.orphanRemovalStrategy = this.orphanRemovalStrategy;
        options.parentPagePublishingStrategy = this.parentPagePublishingStrategy;
        options.notifyWatchers  = this.notifyWatchers;
        return options;
    }

    protected PublishCommand.ConfluenceOptions getConfluenceOptions(){
        PublishCommand.ConfluenceOptions options = new PublishCommand.ConfluenceOptions();
        options.confluenceUrl = this.confluenceUrl;
        options.username = this.username;
        options.password = this.password;
        options.spaceKey = this.spaceKey;
        options.parentPageTitle = this.parentPageTitle;
        options.skipSslVerification = this.skipSslVerification;
        options.maxRequestsPerSecond = this.maxRequestsPerSecond;
        options.connectionTimeToLive = this.connectionTimeToLive;
        return options;
    }

    protected Path getOutputDirectoryAsPath() {
        if (outputDirectory != null) {
            return outputDirectory.toPath();
        } else {
            return null;
        }
    }

}