@yozora/tokenizer-autolink

github flavor markdown spec

Autolinks are absolute URIs and email addresses inside < and >. They are parsed as links, with the URL or email address as the link label.

A URI autolink consists of <, followed by an absolute URI followed by >. It is parsed as a link to the URI, with the URI as the link’s label.

An absolute URI, for these purposes, consists of a scheme followed by a colon (:) followed by zero or more characters other than ASCII whitespace and control characters, <, and >. If the URI includes these characters, they must be percent-encoded (e.g. %20 for a space).

For purposes of this spec, a scheme is any sequence of $2-32$ characters beginning with an ASCII letter and followed by any combination of ASCII letters, digits, or the symbols plus (+), period (.), or hyphen (-).

An email autolink consists of <, followed by an email address, followed by >. The link’s label is the email address, and the URL is mailto: followed by the email address.

An email address, for these purposes, is anything that matches the non-normative regex from the HTML5 spec:

/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/

• See github flavor markdown spec for details.
• See Live Examples for an intuitive impression.

Install

npm

npm install --save @yozora/tokenizer-autolink

Yarn

yarn add @yozora/tokenizer-autolink

pnpm

pnpm add @yozora/tokenizer-autolink

Usage

tip

@yozora/tokenizer-autolink has been integrated into @yozora/parser / @yozora/parser-gfm-ex / @yozora/parser-gfm, so you can use YozoraParser / GfmExParser / GfmParser directly.

Basic Usage

@yozora/tokenizer-autolink cannot be used alone, it needs to be registered in YastParser as a plugin-in before it can be used.

import { DefaultYastParser } from '@yozora/core-parser'
import ParagraphTokenizer from '@yozora/tokenizer-paragraph'
import TextTokenizer from '@yozora/tokenizer-text'
import AutolinkTokenizer from '@yozora/tokenizer-autolink'

const parser = new DefaultYastParser()
  .useBlockFallbackTokenizer(new ParagraphTokenizer())
  .useInlineFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new AutolinkTokenizer())

// parse source markdown content
parser.parse(`
<foo@bar.example.com>

<http://foo.bar.baz>

<made-up-scheme://foo,bar>
`)

YozoraParser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
parser.parse(`
<foo@bar.example.com>

<http://foo.bar.baz>

<made-up-scheme://foo,bar>
`)

GfmParser

import GfmParser from '@yozora/parser-gfm'

const parser = new GfmParser()

// parse source markdown content
parser.parse(`
<foo@bar.example.com>

<http://foo.bar.baz>

<made-up-scheme://foo,bar>
`)

GfmExParser

import GfmExParser from '@yozora/parser-gfm-ex'

const parser = new GfmExParser()

// parse source markdown content
parser.parse(`
<foo@bar.example.com>

<http://foo.bar.baz>

<made-up-scheme://foo,bar>
`)

Options

Name	Type	Required	Default
name	string	false	"@yozora/tokenizer-autolink"
priority	number	false	TokenizerPriority.ATOMIC

• name: The unique name of the tokenizer, used to bind the token it generates, to determine the tokenizer that should be called in each life cycle of the token in the entire matching / parsing phase.

• priority: Priority of the tokenizer, determine the order of processing, high priority priority execution. interruptable. In addition, in the match-block stage, a high-priority tokenizer can interrupt the matching process of a low-priority tokenizer.

  Exception: Delimiters of type full are always processed before other type delimiters.

Types

@yozora/tokenizer-autolink produce Link type nodes. See @yozora/ast for full base types.

import type { YastParent, YastResource } from '@yozora/ast'

export const LinkType = 'link'
export type LinkType = typeof LinkType

/**
 * Link represents a hyperlink.
 * @see https://github.com/syntax-tree/mdast#link
 * @see https://github.github.com/gfm/#inline-link
 */
export interface Link extends YastParent<LinkType>, YastResource {}

Live Examples

• URI autolink.

  #602

  yozora

    

  pretty-json

    

  <http://foo.bar.baz>

  1
  <http://foo.bar.baz>

• Email autolink.

  #612

  yozora

    

  pretty-json

    

  <foo@bar.example.com>

  1
  <foo@bar.example.com>

• Not autolinks.

  #615

  yozora

    

  pretty-json

    

  <>

  1
  <>

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/tokenizer-autolink-extension
• @yozora/tokenizer-link
• @yozora/tokenizer-link-reference
• @yozora/react-link
• @yozora/react-markdown
• Sourcecode
• Link | Yozora AST
• Autolinks | Github Flavor Markdown Spec
• Link | Mdast