com.vladsch.flexmark.ext.gfm.issues.GfmIssuesExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flexmark-ext-gfm-issues Show documentation

flexmark-java extension for GitHub issue syntax

There is a newer version: 0.64.8

Show newest version

package com.vladsch.flexmark.ext.gfm.issues;

import com.vladsch.flexmark.Extension;
import com.vladsch.flexmark.ext.gfm.issues.internal.GfmIssuesInlineParserExtension;
import com.vladsch.flexmark.ext.gfm.issues.internal.GfmIssuesJiraRenderer;
import com.vladsch.flexmark.ext.gfm.issues.internal.GfmIssuesNodeRenderer;
import com.vladsch.flexmark.html.HtmlRenderer;
import com.vladsch.flexmark.parser.Parser;
import com.vladsch.flexmark.util.options.DataKey;
import com.vladsch.flexmark.util.options.MutableDataHolder;

/**
 * Extension for GitHub Issues
 * 
 * Create it with {@link #create()} and then configure it on the builders
 * ({@link com.vladsch.flexmark.parser.Parser.Builder#extensions(Iterable)},
 * {@link com.vladsch.flexmark.html.HtmlRenderer.Builder#extensions(Iterable)}).
 * 
 * 
 * The parsed GitHub issue text is turned into {@link GfmIssue} nodes.
 * 
 */
public class GfmIssuesExtension implements Parser.ParserExtension
        , HtmlRenderer.HtmlRendererExtension
{
    public static final DataKey GIT_HUB_ISSUES_URL_ROOT = new DataKey("GIT_HUB_ISSUES_URL_ROOT", "issues");
    public static final DataKey GIT_HUB_ISSUE_URL_PREFIX = new DataKey("GIT_HUB_ISSUE_URL_PREFIX", "/");
    public static final DataKey GIT_HUB_ISSUE_URL_SUFFIX = new DataKey("GIT_HUB_ISSUE_URL_SUFFIX", "");
    public static final DataKey GIT_HUB_ISSUE_HTML_PREFIX = new DataKey("GIT_HUB_ISSUE_HTML_PREFIX", "");
    public static final DataKey GIT_HUB_ISSUE_HTML_SUFFIX = new DataKey("GIT_HUB_ISSUE_HTML_SUFFIX", "");

    private GfmIssuesExtension() {
    }

    public static Extension create() {
        return new GfmIssuesExtension();
    }

    @Override
    public void rendererOptions(final MutableDataHolder options) {

    }

    @Override
    public void parserOptions(final MutableDataHolder options) {

    }

    @Override
    public void extend(Parser.Builder parserBuilder) {
        parserBuilder.customInlineParserExtensionFactory(new GfmIssuesInlineParserExtension.Factory());
    }

    @Override
    public void extend(HtmlRenderer.Builder rendererBuilder, String rendererType) {
        if (rendererType.equals("HTML")) {
            rendererBuilder.nodeRendererFactory(new GfmIssuesNodeRenderer.Factory());
        } else if (rendererType.equals("JIRA") || rendererType.equals("YOUTRACK")) {
            rendererBuilder.nodeRendererFactory(new GfmIssuesJiraRenderer.Factory());
        }
    }
}