asciidoctor/asciidoctor-intellij-plugin

Suggest link reference on links

Open

#308 opened on Jul 31, 2019

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Java (155 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (392 stars)
PR merge metrics
 (PR metrics pending)

Description

Hi, I'm proposing this enhancement in the plugin. In markdown one can write this :

This is a [Asciidoctor][1].

[1]: http://asciidoctor.org/ "Asciidocotor"

Which is rendered as this

This is a Asciidoctor.

While there's no exact replacement, the document attributes can serve the same purpose, and it is advise by mojavelinux himself ;)

So imagine the following asciidoc

This is a http://asciidoctor.org/[Asciidoctor].

The plugin could suggest, to variabilise the link into a document attribute, maybe propose both of the following forms :

:link-asciidoctor: http://asciidoctor.org/

This is a {link-asciidoctor}[Asciidoctor]

:link-asciidoctor: http://asciidoctor.org/[Asciidoctor]

This is a {link-asciidoctor}

Source :

Contributor guide

Research direction
Examine AsciiDoc document attributes and implement an inspection that detects inline URLs and suggests converting them to attribute references. Reference the user manual and existing plugin inspection patterns.
Tech stack
java
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70