🎉 initiate project *astro_rewrite*
This commit is contained in:
sindrekjelsrud
parent
ffd4d5e86c
commit
2ba37bfbe3
8658 changed files with 2268794 additions and 2538 deletions
4
node_modules/mdast-util-gfm-autolink-literal/index.d.ts
generated
vendored
Normal file
4
node_modules/mdast-util-gfm-autolink-literal/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
export {
|
||||
gfmAutolinkLiteralFromMarkdown,
|
||||
gfmAutolinkLiteralToMarkdown
|
||||
} from './lib/index.js'
|
||||
4
node_modules/mdast-util-gfm-autolink-literal/index.js
generated
vendored
Normal file
4
node_modules/mdast-util-gfm-autolink-literal/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
export {
|
||||
gfmAutolinkLiteralFromMarkdown,
|
||||
gfmAutolinkLiteralToMarkdown
|
||||
} from './lib/index.js'
|
||||
24
node_modules/mdast-util-gfm-autolink-literal/lib/index.d.ts
generated
vendored
Normal file
24
node_modules/mdast-util-gfm-autolink-literal/lib/index.d.ts
generated
vendored
Normal file
|
|
@ -0,0 +1,24 @@
|
|||
/**
|
||||
* Extension for `mdast-util-from-markdown` to enable GFM autolink literals.
|
||||
*
|
||||
* @type {FromMarkdownExtension}
|
||||
*/
|
||||
export const gfmAutolinkLiteralFromMarkdown: FromMarkdownExtension
|
||||
/**
|
||||
* Extension for `mdast-util-to-markdown` to enable GFM autolink literals.
|
||||
*
|
||||
* @type {ToMarkdownExtension}
|
||||
*/
|
||||
export const gfmAutolinkLiteralToMarkdown: ToMarkdownExtension
|
||||
export type Link = import('mdast').Link
|
||||
export type PhrasingContent = import('mdast').PhrasingContent
|
||||
export type CompileContext = import('mdast-util-from-markdown').CompileContext
|
||||
export type FromMarkdownExtension = import('mdast-util-from-markdown').Extension
|
||||
export type FromMarkdownHandle = import('mdast-util-from-markdown').Handle
|
||||
export type FromMarkdownTransform = import('mdast-util-from-markdown').Transform
|
||||
export type ConstructName = import('mdast-util-to-markdown').ConstructName
|
||||
export type ToMarkdownExtension = import('mdast-util-to-markdown').Options
|
||||
export type ReplaceFunction =
|
||||
import('mdast-util-find-and-replace').ReplaceFunction
|
||||
export type RegExpMatchObject =
|
||||
import('mdast-util-find-and-replace').RegExpMatchObject
|
||||
274
node_modules/mdast-util-gfm-autolink-literal/lib/index.js
generated
vendored
Normal file
274
node_modules/mdast-util-gfm-autolink-literal/lib/index.js
generated
vendored
Normal file
|
|
@ -0,0 +1,274 @@
|
|||
/**
|
||||
* @typedef {import('mdast').Link} Link
|
||||
* @typedef {import('mdast').PhrasingContent} PhrasingContent
|
||||
*
|
||||
* @typedef {import('mdast-util-from-markdown').CompileContext} CompileContext
|
||||
* @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
|
||||
* @typedef {import('mdast-util-from-markdown').Handle} FromMarkdownHandle
|
||||
* @typedef {import('mdast-util-from-markdown').Transform} FromMarkdownTransform
|
||||
*
|
||||
* @typedef {import('mdast-util-to-markdown').ConstructName} ConstructName
|
||||
* @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
|
||||
*
|
||||
* @typedef {import('mdast-util-find-and-replace').ReplaceFunction} ReplaceFunction
|
||||
* @typedef {import('mdast-util-find-and-replace').RegExpMatchObject} RegExpMatchObject
|
||||
*/
|
||||
|
||||
import {ccount} from 'ccount'
|
||||
import {findAndReplace} from 'mdast-util-find-and-replace'
|
||||
import {unicodePunctuation, unicodeWhitespace} from 'micromark-util-character'
|
||||
|
||||
/** @type {ConstructName} */
|
||||
const inConstruct = 'phrasing'
|
||||
/** @type {Array<ConstructName>} */
|
||||
const notInConstruct = ['autolink', 'link', 'image', 'label']
|
||||
|
||||
// To do: next major: expose functions instead of extensions.
|
||||
|
||||
/**
|
||||
* Extension for `mdast-util-from-markdown` to enable GFM autolink literals.
|
||||
*
|
||||
* @type {FromMarkdownExtension}
|
||||
*/
|
||||
export const gfmAutolinkLiteralFromMarkdown = {
|
||||
transforms: [transformGfmAutolinkLiterals],
|
||||
enter: {
|
||||
literalAutolink: enterLiteralAutolink,
|
||||
literalAutolinkEmail: enterLiteralAutolinkValue,
|
||||
literalAutolinkHttp: enterLiteralAutolinkValue,
|
||||
literalAutolinkWww: enterLiteralAutolinkValue
|
||||
},
|
||||
exit: {
|
||||
literalAutolink: exitLiteralAutolink,
|
||||
literalAutolinkEmail: exitLiteralAutolinkEmail,
|
||||
literalAutolinkHttp: exitLiteralAutolinkHttp,
|
||||
literalAutolinkWww: exitLiteralAutolinkWww
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extension for `mdast-util-to-markdown` to enable GFM autolink literals.
|
||||
*
|
||||
* @type {ToMarkdownExtension}
|
||||
*/
|
||||
export const gfmAutolinkLiteralToMarkdown = {
|
||||
unsafe: [
|
||||
{
|
||||
character: '@',
|
||||
before: '[+\\-.\\w]',
|
||||
after: '[\\-.\\w]',
|
||||
inConstruct,
|
||||
notInConstruct
|
||||
},
|
||||
{
|
||||
character: '.',
|
||||
before: '[Ww]',
|
||||
after: '[\\-.\\w]',
|
||||
inConstruct,
|
||||
notInConstruct
|
||||
},
|
||||
{character: ':', before: '[ps]', after: '\\/', inConstruct, notInConstruct}
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function enterLiteralAutolink(token) {
|
||||
this.enter({type: 'link', title: null, url: '', children: []}, token)
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function enterLiteralAutolinkValue(token) {
|
||||
this.config.enter.autolinkProtocol.call(this, token)
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function exitLiteralAutolinkHttp(token) {
|
||||
this.config.exit.autolinkProtocol.call(this, token)
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function exitLiteralAutolinkWww(token) {
|
||||
this.config.exit.data.call(this, token)
|
||||
const node = /** @type {Link} */ (this.stack[this.stack.length - 1])
|
||||
node.url = 'http://' + this.sliceSerialize(token)
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function exitLiteralAutolinkEmail(token) {
|
||||
this.config.exit.autolinkEmail.call(this, token)
|
||||
}
|
||||
|
||||
/**
|
||||
* @this {CompileContext}
|
||||
* @type {FromMarkdownHandle}
|
||||
*/
|
||||
function exitLiteralAutolink(token) {
|
||||
this.exit(token)
|
||||
}
|
||||
|
||||
/** @type {FromMarkdownTransform} */
|
||||
function transformGfmAutolinkLiterals(tree) {
|
||||
findAndReplace(
|
||||
tree,
|
||||
[
|
||||
[/(https?:\/\/|www(?=\.))([-.\w]+)([^ \t\r\n]*)/gi, findUrl],
|
||||
[/([-.\w+]+)@([-\w]+(?:\.[-\w]+)+)/g, findEmail]
|
||||
],
|
||||
{ignore: ['link', 'linkReference']}
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* @type {ReplaceFunction}
|
||||
* @param {string} _
|
||||
* @param {string} protocol
|
||||
* @param {string} domain
|
||||
* @param {string} path
|
||||
* @param {RegExpMatchObject} match
|
||||
* @returns {Link | Array<PhrasingContent> | false}
|
||||
*/
|
||||
// eslint-disable-next-line max-params
|
||||
function findUrl(_, protocol, domain, path, match) {
|
||||
let prefix = ''
|
||||
|
||||
// Not an expected previous character.
|
||||
if (!previous(match)) {
|
||||
return false
|
||||
}
|
||||
|
||||
// Treat `www` as part of the domain.
|
||||
if (/^w/i.test(protocol)) {
|
||||
domain = protocol + domain
|
||||
protocol = ''
|
||||
prefix = 'http://'
|
||||
}
|
||||
|
||||
if (!isCorrectDomain(domain)) {
|
||||
return false
|
||||
}
|
||||
|
||||
const parts = splitUrl(domain + path)
|
||||
|
||||
if (!parts[0]) return false
|
||||
|
||||
/** @type {Link} */
|
||||
const result = {
|
||||
type: 'link',
|
||||
title: null,
|
||||
url: prefix + protocol + parts[0],
|
||||
children: [{type: 'text', value: protocol + parts[0]}]
|
||||
}
|
||||
|
||||
if (parts[1]) {
|
||||
return [result, {type: 'text', value: parts[1]}]
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
/**
|
||||
* @type {ReplaceFunction}
|
||||
* @param {string} _
|
||||
* @param {string} atext
|
||||
* @param {string} label
|
||||
* @param {RegExpMatchObject} match
|
||||
* @returns {Link | false}
|
||||
*/
|
||||
function findEmail(_, atext, label, match) {
|
||||
if (
|
||||
// Not an expected previous character.
|
||||
!previous(match, true) ||
|
||||
// Label ends in not allowed character.
|
||||
/[-\d_]$/.test(label)
|
||||
) {
|
||||
return false
|
||||
}
|
||||
|
||||
return {
|
||||
type: 'link',
|
||||
title: null,
|
||||
url: 'mailto:' + atext + '@' + label,
|
||||
children: [{type: 'text', value: atext + '@' + label}]
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} domain
|
||||
* @returns {boolean}
|
||||
*/
|
||||
function isCorrectDomain(domain) {
|
||||
const parts = domain.split('.')
|
||||
|
||||
if (
|
||||
parts.length < 2 ||
|
||||
(parts[parts.length - 1] &&
|
||||
(/_/.test(parts[parts.length - 1]) ||
|
||||
!/[a-zA-Z\d]/.test(parts[parts.length - 1]))) ||
|
||||
(parts[parts.length - 2] &&
|
||||
(/_/.test(parts[parts.length - 2]) ||
|
||||
!/[a-zA-Z\d]/.test(parts[parts.length - 2])))
|
||||
) {
|
||||
return false
|
||||
}
|
||||
|
||||
return true
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} url
|
||||
* @returns {[string, string | undefined]}
|
||||
*/
|
||||
function splitUrl(url) {
|
||||
const trailExec = /[!"&'),.:;<>?\]}]+$/.exec(url)
|
||||
|
||||
if (!trailExec) {
|
||||
return [url, undefined]
|
||||
}
|
||||
|
||||
url = url.slice(0, trailExec.index)
|
||||
|
||||
let trail = trailExec[0]
|
||||
let closingParenIndex = trail.indexOf(')')
|
||||
const openingParens = ccount(url, '(')
|
||||
let closingParens = ccount(url, ')')
|
||||
|
||||
while (closingParenIndex !== -1 && openingParens > closingParens) {
|
||||
url += trail.slice(0, closingParenIndex + 1)
|
||||
trail = trail.slice(closingParenIndex + 1)
|
||||
closingParenIndex = trail.indexOf(')')
|
||||
closingParens++
|
||||
}
|
||||
|
||||
return [url, trail]
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {RegExpMatchObject} match
|
||||
* @param {boolean | null | undefined} [email=false]
|
||||
* @returns {boolean}
|
||||
*/
|
||||
function previous(match, email) {
|
||||
const code = match.input.charCodeAt(match.index - 1)
|
||||
|
||||
return (
|
||||
(match.index === 0 ||
|
||||
unicodeWhitespace(code) ||
|
||||
unicodePunctuation(code)) &&
|
||||
(!email || code !== 47)
|
||||
)
|
||||
}
|
||||
22
node_modules/mdast-util-gfm-autolink-literal/license
generated
vendored
Normal file
22
node_modules/mdast-util-gfm-autolink-literal/license
generated
vendored
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
(The MIT License)
|
||||
|
||||
Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
103
node_modules/mdast-util-gfm-autolink-literal/package.json
generated
vendored
Normal file
103
node_modules/mdast-util-gfm-autolink-literal/package.json
generated
vendored
Normal file
|
|
@ -0,0 +1,103 @@
|
|||
{
|
||||
"name": "mdast-util-gfm-autolink-literal",
|
||||
"version": "1.0.3",
|
||||
"description": "mdast extension to parse and serialize GFM autolink literals",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"unist",
|
||||
"mdast",
|
||||
"mdast-util",
|
||||
"util",
|
||||
"utility",
|
||||
"markdown",
|
||||
"markup",
|
||||
"autolink",
|
||||
"auto",
|
||||
"link",
|
||||
"literal",
|
||||
"url",
|
||||
"raw",
|
||||
"gfm"
|
||||
],
|
||||
"repository": "syntax-tree/mdast-util-gfm-autolink-literal",
|
||||
"bugs": "https://github.com/syntax-tree/mdast-util-gfm-autolink-literal/issues",
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
},
|
||||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
|
||||
"contributors": [
|
||||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"type": "module",
|
||||
"main": "index.js",
|
||||
"types": "index.d.ts",
|
||||
"files": [
|
||||
"lib/",
|
||||
"index.d.ts",
|
||||
"index.js"
|
||||
],
|
||||
"dependencies": {
|
||||
"@types/mdast": "^3.0.0",
|
||||
"ccount": "^2.0.0",
|
||||
"mdast-util-find-and-replace": "^2.0.0",
|
||||
"micromark-util-character": "^1.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "^18.0.0",
|
||||
"c8": "^7.0.0",
|
||||
"hast-util-to-html": "^8.0.0",
|
||||
"mdast-util-from-markdown": "^1.0.0",
|
||||
"mdast-util-to-hast": "^12.0.0",
|
||||
"mdast-util-to-markdown": "^1.0.0",
|
||||
"micromark-extension-gfm-autolink-literal": "^1.0.0",
|
||||
"prettier": "^2.0.0",
|
||||
"remark-cli": "^11.0.0",
|
||||
"remark-preset-wooorm": "^9.0.0",
|
||||
"type-coverage": "^2.0.0",
|
||||
"typescript": "^4.0.0",
|
||||
"xo": "^0.53.0"
|
||||
},
|
||||
"scripts": {
|
||||
"prepack": "npm run build && npm run format",
|
||||
"build": "tsc --build --clean && tsc --build && type-coverage",
|
||||
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
|
||||
"test-api": "node --conditions development test/index.js",
|
||||
"test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
|
||||
"test": "npm run build && npm run format && npm run test-coverage"
|
||||
},
|
||||
"prettier": {
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"trailingComma": "none"
|
||||
},
|
||||
"xo": {
|
||||
"prettier": true,
|
||||
"rules": {
|
||||
"unicorn/prefer-code-point": "off"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"files": "test/**/*.js",
|
||||
"rules": {
|
||||
"no-await-in-loop": "off"
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"remark-preset-wooorm"
|
||||
]
|
||||
},
|
||||
"typeCoverage": {
|
||||
"atLeast": 100,
|
||||
"detail": true,
|
||||
"strict": true,
|
||||
"ignoreCatch": true
|
||||
}
|
||||
}
|
||||
318
node_modules/mdast-util-gfm-autolink-literal/readme.md
generated
vendored
Normal file
318
node_modules/mdast-util-gfm-autolink-literal/readme.md
generated
vendored
Normal file
|
|
@ -0,0 +1,318 @@
|
|||
# mdast-util-gfm-autolink-literal
|
||||
|
||||
[![Build][build-badge]][build]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Downloads][downloads-badge]][downloads]
|
||||
[![Size][size-badge]][size]
|
||||
[![Sponsors][sponsors-badge]][collective]
|
||||
[![Backers][backers-badge]][collective]
|
||||
[![Chat][chat-badge]][chat]
|
||||
|
||||
[mdast][] extensions to parse and serialize [GFM][] autolink literals.
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When to use this](#when-to-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`gfmAutolinkLiteralFromMarkdown`](#gfmautolinkliteralfrommarkdown)
|
||||
* [`gfmAutolinkLiteralToMarkdown`](#gfmautolinkliteraltomarkdown)
|
||||
* [HTML](#html)
|
||||
* [Syntax](#syntax)
|
||||
* [Syntax tree](#syntax-tree)
|
||||
* [Types](#types)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Related](#related)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## 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`][mdast-util-from-markdown] (to support parsing
|
||||
GFM autolinks in markdown into a syntax tree) and
|
||||
[`mdast-util-to-markdown`][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`][extension] 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`][extension].
|
||||
|
||||
When you don’t need a syntax tree, you can use [`micromark`][micromark]
|
||||
directly with `micromark-extension-gfm-autolink-literal`.
|
||||
|
||||
When you are working with syntax trees and want all of GFM, use
|
||||
[`mdast-util-gfm`][mdast-util-gfm] instead.
|
||||
|
||||
All these packages are used [`remark-gfm`][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`][mdast-util-to-hast].
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install mdast-util-gfm-autolink-literal
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {gfmAutolinkLiteralFromMarkdown, gfmAutolinkLiteralToMarkdown} from 'https://esm.sh/mdast-util-gfm-autolink-literal@1'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {gfmAutolinkLiteralFromMarkdown, gfmAutolinkLiteralToMarkdown} from 'https://esm.sh/mdast-util-gfm-autolink-literal@1?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Say our document `example.md` contains:
|
||||
|
||||
```markdown
|
||||
www.example.com, https://example.com, and contact@example.com.
|
||||
```
|
||||
|
||||
…and our module `example.js` looks as follows:
|
||||
|
||||
```js
|
||||
import fs from 'node:fs/promises'
|
||||
import {fromMarkdown} from 'mdast-util-from-markdown'
|
||||
import {toMarkdown} from 'mdast-util-to-markdown'
|
||||
import {gfmAutolinkLiteral} from 'micromark-extension-gfm-autolink-literal'
|
||||
import {gfmAutolinkLiteralFromMarkdown, gfmAutolinkLiteralToMarkdown} from 'mdast-util-gfm-autolink-literal'
|
||||
|
||||
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):
|
||||
|
||||
```js
|
||||
{
|
||||
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:contact@example.com',
|
||||
children: [{type: 'text', value: 'contact@example.com'}]
|
||||
},
|
||||
{type: 'text', value: '.'}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```markdown
|
||||
[www.example.com](http://www.example.com), <https://example.com>, and <contact@example.com>.
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This package exports the identifiers
|
||||
[`gfmAutolinkLiteralFromMarkdown`][api-gfmautolinkliteralfrommarkdown] and
|
||||
[`gfmAutolinkLiteralToMarkdown`][api-gfmautolinkliteraltomarkdown].
|
||||
There is no default export.
|
||||
|
||||
### `gfmAutolinkLiteralFromMarkdown`
|
||||
|
||||
Extension for [`mdast-util-from-markdown`][mdast-util-from-markdown] to enable
|
||||
GFM autolink literals ([`FromMarkdownExtension`][frommarkdownextension]).
|
||||
|
||||
### `gfmAutolinkLiteralToMarkdown`
|
||||
|
||||
Extension for [`mdast-util-to-markdown`][mdast-util-to-markdown] to enable
|
||||
GFM autolink literals ([`ToMarkdownExtension`][tomarkdownextension]).
|
||||
|
||||
## HTML
|
||||
|
||||
This utility does not handle how markdown is turned to HTML.
|
||||
That’s done by [`mdast-util-to-hast`][mdast-util-to-hast].
|
||||
|
||||
## Syntax
|
||||
|
||||
See [Syntax in `micromark-extension-gfm-autolink-literal`][syntax].
|
||||
|
||||
## Syntax tree
|
||||
|
||||
There are no interfaces added to **[mdast][]** by this utility, as it reuses
|
||||
the existing **[Link][dfn-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 all maintained
|
||||
versions of Node.js.
|
||||
As of now, that is Node.js 14.14+ and 16.0+.
|
||||
Our projects sometimes work with older versions, but this is not guaranteed.
|
||||
|
||||
This plugin works with `mdast-util-from-markdown` version 1+ and
|
||||
`mdast-util-to-markdown` version 1+.
|
||||
|
||||
## Related
|
||||
|
||||
* [`remarkjs/remark-gfm`][remark-gfm]
|
||||
— remark plugin to support GFM
|
||||
* [`syntax-tree/mdast-util-gfm`][mdast-util-gfm]
|
||||
— same but all of GFM (autolink literals, footnotes, strikethrough, tables,
|
||||
tasklists)
|
||||
* [`micromark/micromark-extension-gfm-autolink-literal`][extension]
|
||||
— micromark extension to parse GFM autolink literals
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
|
||||
ways to get started.
|
||||
See [`support.md`][support] for ways to get help.
|
||||
|
||||
This project has a [code of conduct][coc].
|
||||
By interacting with this repository, organization, or community you agree to
|
||||
abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
[MIT][license] © [Titus Wormer][author]
|
||||
|
||||
<!-- Definitions -->
|
||||
|
||||
[build-badge]: https://github.com/syntax-tree/mdast-util-gfm-autolink-literal/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/syntax-tree/mdast-util-gfm-autolink-literal/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm-autolink-literal.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm-autolink-literal
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm-autolink-literal.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/mdast-util-gfm-autolink-literal
|
||||
|
||||
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-gfm-autolink-literal.svg
|
||||
|
||||
[size]: https://bundlephobia.com/result?p=mdast-util-gfm-autolink-literal
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[collective]: https://opencollective.com/unified
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[chat]: https://github.com/syntax-tree/unist/discussions
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[health]: https://github.com/syntax-tree/.github
|
||||
|
||||
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
|
||||
|
||||
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
|
||||
|
||||
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
|
||||
|
||||
[mdast]: https://github.com/syntax-tree/mdast
|
||||
|
||||
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
|
||||
|
||||
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
|
||||
|
||||
[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
|
||||
|
||||
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
|
||||
|
||||
[remark-gfm]: https://github.com/remarkjs/remark-gfm
|
||||
|
||||
[micromark]: https://github.com/micromark/micromark
|
||||
|
||||
[extension]: https://github.com/micromark/micromark-extension-gfm-autolink-literal
|
||||
|
||||
[syntax]: https://github.com/micromark/micromark-extension-gfm-autolink-literal#syntax
|
||||
|
||||
[gfm]: https://github.github.com/gfm/
|
||||
|
||||
[dfn-link]: https://github.com/syntax-tree/mdast#link
|
||||
|
||||
[frommarkdownextension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
|
||||
|
||||
[tomarkdownextension]: https://github.com/syntax-tree/mdast-util-to-markdown#options
|
||||
|
||||
[api-gfmautolinkliteralfrommarkdown]: #gfmautolinkliteralfrommarkdown
|
||||
|
||||
[api-gfmautolinkliteraltomarkdown]: #gfmautolinkliteraltomarkdown
|
||||
Loading…
Add table
Add a link
Reference in a new issue