npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

mdast-util-gfm-autolink-literal

v2.0.1

Published

mdast extension to parse and serialize GFM autolink literals

Downloads

17,164,291

Readme

mdast-util-gfm-autolink-literal

Build Coverage Downloads Size Sponsors Backers Chat

mdast extensions to parse and serialize GFM autolink literals.

Contents

What is this?

This package contains two extensions that add support for GFM autolink literals syntax in markdown to mdast. These extensions plug into mdast-util-from-markdown (to support parsing GFM autolinks in markdown into a syntax tree) and mdast-util-to-markdown (to support serializing GFM autolinks in syntax trees to markdown).

GitHub employs different algorithms to autolink: one at parse time and one at transform time (similar to how @mentions are done at transform time). This difference can be observed because character references and escapes are handled differently. But also because issues/PRs/comments omit (perhaps by accident?) the second algorithm for www., http://, and https:// links (but not for email links).

As the corresponding micromark extension micromark-extension-gfm-autolink-literal is a syntax extension, it can only perform the first algorithm. The tree extension gfmAutolinkLiteralFromMarkdown from this package can perform the second algorithm, and as they are combined, both are done.

When to use this

You can use these extensions when you are working with mdast-util-from-markdown and mdast-util-to-markdown already.

When working with mdast-util-from-markdown, you must combine this package with micromark-extension-gfm-autolink-literal.

When you don’t need a syntax tree, you can use micromark directly with micromark-extension-gfm-autolink-literal.

When you are working with syntax trees and want all of GFM, use mdast-util-gfm instead.

All these packages are used remark-gfm, which focusses on making it easier to transform content by abstracting these internals away.

This utility does not handle how markdown is turned to HTML. That’s done by mdast-util-to-hast.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install mdast-util-gfm-autolink-literal

In Deno with esm.sh:

import {gfmAutolinkLiteralFromMarkdown, gfmAutolinkLiteralToMarkdown} from 'https://esm.sh/mdast-util-gfm-autolink-literal@2'

In browsers with esm.sh:

<script type="module">
  import {gfmAutolinkLiteralFromMarkdown, gfmAutolinkLiteralToMarkdown} from 'https://esm.sh/mdast-util-gfm-autolink-literal@2?bundle'
</script>

Use

Say our document example.md contains:

www.example.com, https://example.com, and [email protected].

…and our module example.js looks as follows:

import fs from 'node:fs/promises'
import {gfmAutolinkLiteral} from 'micromark-extension-gfm-autolink-literal'
import {fromMarkdown} from 'mdast-util-from-markdown'
import {
  gfmAutolinkLiteralFromMarkdown,
  gfmAutolinkLiteralToMarkdown
} from 'mdast-util-gfm-autolink-literal'
import {toMarkdown} from 'mdast-util-to-markdown'

const doc = await fs.readFile('example.md')

const tree = fromMarkdown(doc, {
  extensions: [gfmAutolinkLiteral()],
  mdastExtensions: [gfmAutolinkLiteralFromMarkdown()]
})

console.log(tree)

const out = toMarkdown(tree, {extensions: [gfmAutolinkLiteralToMarkdown()]})

console.log(out)

…now running node example.js yields (positional info removed for brevity):

{
  type: 'root',
  children: [
    {
      type: 'paragraph',
      children: [
        {
          type: 'link',
          title: null,
          url: 'http://www.example.com',
          children: [{type: 'text', value: 'www.example.com'}]
        },
        {type: 'text', value: ', '},
        {
          type: 'link',
          title: null,
          url: 'https://example.com',
          children: [{type: 'text', value: 'https://example.com'}]
        },
        {type: 'text', value: ', and '},
        {
          type: 'link',
          title: null,
          url: 'mailto:[email protected]',
          children: [{type: 'text', value: '[email protected]'}]
        },
        {type: 'text', value: '.'}
      ]
    }
  ]
}
[www.example.com](http://www.example.com), <https://example.com>, and <[email protected]>.

API

This package exports the identifiers gfmAutolinkLiteralFromMarkdown and gfmAutolinkLiteralToMarkdown. There is no default export.

gfmAutolinkLiteralFromMarkdown()

Create an extension for mdast-util-from-markdown to enable GFM autolink literals in markdown.

Returns

Extension for mdast-util-to-markdown to enable GFM autolink literals (FromMarkdownExtension).

gfmAutolinkLiteralToMarkdown()

Create an extension for mdast-util-to-markdown to enable GFM autolink literals in markdown.

Returns

Extension for mdast-util-to-markdown to enable GFM autolink literals (ToMarkdownExtension).

HTML

This utility does not handle how markdown is turned to HTML. That’s done by mdast-util-to-hast.

Syntax

See Syntax in micromark-extension-gfm-autolink-literal.

Syntax tree

There are no interfaces added to mdast by this utility, as it reuses the existing Link interface.

Types

This package is fully typed with TypeScript. It does not export additional types.

The Link type of the mdast nodes is exposed from @types/mdast.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, mdast-util-gfm-autolink-literal@^2, compatible with Node.js 16.

This utility works with mdast-util-from-markdown version 2+ and mdast-util-to-markdown version 2+.

Related

Contribute

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer