asciidoctor/asciidoctor-gradle-plugin

Replace {gradle-relative-srcdir} in gradle asciidoctor task configuration

Open

#455 opened on Oct 17, 2019

View on GitHub
 (4 comments) (3 reactions) (1 assignee)Groovy (110 forks)batch import
5.xenhancementhelp wanted

Repository metrics

Stars
 (265 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hi,

In #292 (v2.2.0) the plugin offered the nifty {gradle-relative-srcdir} attributes, however it can only be used in the documents themselves. I'm thinking that an improvement could be made to post process the attributes configured in the asciidoctor task in order to replace attributes such as {gradle-relative-srcdir} upon processing a (nested) document.

Otherwise it imposes to define in all documents attributes such as highlightjsdir and stylesdir, I'd rather write :

attributes = [
        'snippets'          : snippetsDir,
        'source-highlighter': 'highlight.js',
        'highlightjs-theme' : 'gruvbox-dark',
        'highlightjsdir'    : '{gradle-relative-srcdir}/highlight',
        'stylesheet'        : 'asciidark.css',
        'stylesdir'         : '{gradle-relative-srcdir}',
        'linkcss'           : 'true',
        'encoding'          : 'utf-8'
]

Contributor guide

Research direction
Examine the asciidoctor task configuration in the plugin source code to identify where attributes are processed, then add a post processing step to replace {gradle relative srcdir} with the computed relative source directory.
Tech stack
groovy
Domain
build systembackend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GradleGroovy
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60