thephpleague / commonmark-ext-autolink

Extension for league/commonmark which autolinks URLs, emails, and @-mentions

URL and email autolinking extension for league/commonmark

DEPRECATED

This extension has been deprecated. All of its functionality now exists in league/commonmark 1.3+ under the League\CommonMark\Extension\Autolink namespace, so you should upgrade to that version and use that bundled extension instead of this one.

Overview

This extension adds GFM-style autolinking to the league/commonmark Markdown parser for PHP. It automatically link URLs and email addresses even when the CommonMark <...> autolink syntax is not used.

It also provides a parser to autolink @mentions to Twitter, Github, or any custom service you wish, though this is disabled by default.

Install

Via Composer

$ composer require league/commonmark-ext-autolink

Usage

Configure your Environment as usual and simply add the AutolinkExtension provided by this package:

use League\CommonMark\CommonMarkConverter;
use League\CommonMark\Environment;
use League\CommonMark\Ext\Autolink\AutolinkExtension;

// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go
$environment = Environment::createCommonMarkEnvironment();

// Add this extension
$environment->addExtension(new AutolinkExtension());

// Instantiate the converter engine and start converting some Markdown!
$converter = new CommonMarkConverter([], $environment);
echo $converter->convertToHtml('I successfully installed the https://github.com/thephpleague/commonmark-ext-autolink extension!');

@mention Autolinking

This extension also provides functionality to automatically link "mentions" like @colinodell to Twitter, Github, or any other site of your choice!

For Twitter:

use League\CommonMark\Environment;
use League\CommonMark\Ext\Autolink\InlineMentionParser;

$environment = Environment::createCommonMarkEnvironment();
$environment->addInlineParser(InlineMentionParser::createTwitterHandleParser());

// TODO: Instantiate your converter and convert some Markdown

For GitHub:

use League\CommonMark\Environment;
use League\CommonMark\Ext\Autolink\InlineMentionParser;

$environment = Environment::createCommonMarkEnvironment();
$environment->addInlineParser(InlineMentionParser::createGithubHandleParser());

// TODO: Instantiate your converter and convert some Markdown

Or configure your own custom one:

use League\CommonMark\Environment;
use League\CommonMark\Ext\Autolink\InlineMentionParser;

$environment = Environment::createCommonMarkEnvironment();
$environment->addInlineParser(new InlineMentionParser('https://www.example.com/users/%s/profile'));

// TODO: Instantiate your converter and convert some Markdown

When creating your own, you can provide two parameters to the constructor:

• A URL template where %s is replaced with the username (required)
• A regular expression to parse and validate the username (optional - defaults to '/^[A-Za-z0-9_]+(?!\w)/')

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

• Colin O'Dell
• All Contributors

License

This library is licensed under the BSD-3 license. See the License File for more information.

commonmark-ext-autolink's Issues

Makes double links for <https://example.com/>

This extension does not take into account existing inline links surrounded by angle brackets, such as <https://example.com/> - this causes them to get doubled up with an anchor tag inside another anchor tag.

$environment = \League\CommonMark\Environment::createCommonMarkEnvironment()
    ->addExtension(new \League\CommonMark\Ext\Autolink\AutolinkExtension());

$commonMarkConverter = new \League\CommonMark\CommonMarkConverter([], $environment);

$commonMarkConverter->convertToHtml('<https://example.com/>');

// Expected: '<p><a href="https://example.com/">https://example.com/</a></p>'

// Actual: '<p><a href="https://example.com/"><a href="https://example.com/">https://example.com/</a></a></p>'

links with underscores linked incorrectly

smartpunct and autolink don't play well

input:

it’s
https://eventum.example.net/history.php?iss_id=107092
https://gitlab.example.net/group/project/merge_requests/39#note_150630

output:

<p>it’s<br />
<a href="https://eventum.example.net/history.php?iss">https://eventum.example.net/history.php?iss</a>_id=107092<br />
<a href="https://gitlab.example.net/group/project/merge">https://gitlab.example.net/group/project/merge</a>_requests/39#note_150630</p>

remove the apostrophe ’ and links get formatted properly:

<p>it<br />
<a href="https://eventum.example.net/history.php?iss_id=107092">https://eventum.example.net/history.php?iss_id=107092</a><br />
<a href="https://gitlab.example.net/group/project/merge">https://gitlab.example.net/group/project/merge</a>_requests/39#note_150630</p>

wait, the second link still wrong.

doesn't matter which apostrophe being used, or are they in pairs:

• it's, it's ' ...

versions (if that's relevant):

league/commonmark                  0.18.2               PHP Markdown parser...
league/commonmark-ext-autolink     v0.2.0               Extension for leagu...
league/commonmark-ext-inlines-only v0.1.0               Extension for leagu...
league/commonmark-ext-smartpunct   v0.1.0               Intelligently conve...
league/commonmark-extras           0.2.1                Useful extensions f...

Characters after a link reversed.

In the following example:
[image src='<image>' caption='source: ( https://www.example.com/test). ']

The resulting caption for the image is:
source: (https://www.example.com/test.)
The . and ) at the end are reversed.

This only happens with some links, specifically the /test in the example was necessary to reproduce the error. I think the closing paren that gets chopped off in processAutoLinks() needs to be prepended to $leftovers instead of appended. But I'm unsure if that is correct in all cases.

Make compatible with league/commonmark 0.19

• Bump the constraint
• Type ALL THE THINGS
• Make private constants actually be private

Fully implement the GFM spec

See https://github.github.com/gfm/#autolinks-extension-

Autolink broken on multi-line?

$text = 'fsdfasdfsad ```foo``` 


 https://httpd.apache.org/docs/2.4/howto/access.html#host';

echo $markdown->convertToHtml($text);

This code fails to auto-link

Version 0.3.0

Extensibility question

So, if I want to do some customizations on the @-auto-linking. Should I just copy the class, as it's declared final and the logic inside is not very complex?

started something here:

• eventum/eventum#507

but really I want to do some internal lookup of the match, skip expanding if lookup not found, and on match add title html attribute. And don't actually want to link the handle, because there's yet no user page in that application.