This commit is contained in:
2024-03-22 03:47:51 +05:30
parent 8bcf3d211e
commit 89819f6fe2
28440 changed files with 3211033 additions and 2 deletions

25
node_modules/mdast-util-gfm-footnote/index.d.ts generated vendored Normal file
View File

@@ -0,0 +1,25 @@
export {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from './lib/index.js'
declare module 'mdast-util-to-markdown' {
interface ConstructNameMap {
/**
* Footnote reference.
*
* ```markdown
* > | A[^b].
* ^^^^
* ```
*/
footnoteReference: 'footnoteReference'
/**
* Footnote definition.
*
* ```markdown
* > | [^a]: B.
* ^^^^^^^^
* ```
*/
footnoteDefinition: 'footnoteDefinition'
}
}

2
node_modules/mdast-util-gfm-footnote/index.js generated vendored Normal file
View File

@@ -0,0 +1,2 @@
// Note: extra types exported from `index.d.ts`.
export {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from './lib/index.js'

24
node_modules/mdast-util-gfm-footnote/lib/index.d.ts generated vendored Normal file
View File

@@ -0,0 +1,24 @@
/**
* Create an extension for `mdast-util-from-markdown` to enable GFM footnotes
* in markdown.
*
* @returns {FromMarkdownExtension}
* Extension for `mdast-util-from-markdown`.
*/
export function gfmFootnoteFromMarkdown(): FromMarkdownExtension
/**
* Create an extension for `mdast-util-to-markdown` to enable GFM footnotes
* in markdown.
*
* @returns {ToMarkdownExtension}
* Extension for `mdast-util-to-markdown`.
*/
export function gfmFootnoteToMarkdown(): ToMarkdownExtension
export type FootnoteDefinition = import('mdast').FootnoteDefinition
export type FootnoteReference = import('mdast').FootnoteReference
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 ToMarkdownHandle = import('mdast-util-to-markdown').Handle
export type Map = import('mdast-util-to-markdown').Map
export type ToMarkdownExtension = import('mdast-util-to-markdown').Options

198
node_modules/mdast-util-gfm-footnote/lib/index.js generated vendored Normal file
View File

@@ -0,0 +1,198 @@
/**
* @typedef {import('mdast').FootnoteDefinition} FootnoteDefinition
* @typedef {import('mdast').FootnoteReference} FootnoteReference
* @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-to-markdown').Handle} ToMarkdownHandle
* @typedef {import('mdast-util-to-markdown').Map} Map
* @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
*/
import {ok as assert} from 'devlop'
import {normalizeIdentifier} from 'micromark-util-normalize-identifier'
footnoteReference.peek = footnoteReferencePeek
/**
* Create an extension for `mdast-util-from-markdown` to enable GFM footnotes
* in markdown.
*
* @returns {FromMarkdownExtension}
* Extension for `mdast-util-from-markdown`.
*/
export function gfmFootnoteFromMarkdown() {
return {
enter: {
gfmFootnoteDefinition: enterFootnoteDefinition,
gfmFootnoteDefinitionLabelString: enterFootnoteDefinitionLabelString,
gfmFootnoteCall: enterFootnoteCall,
gfmFootnoteCallString: enterFootnoteCallString
},
exit: {
gfmFootnoteDefinition: exitFootnoteDefinition,
gfmFootnoteDefinitionLabelString: exitFootnoteDefinitionLabelString,
gfmFootnoteCall: exitFootnoteCall,
gfmFootnoteCallString: exitFootnoteCallString
}
}
}
/**
* Create an extension for `mdast-util-to-markdown` to enable GFM footnotes
* in markdown.
*
* @returns {ToMarkdownExtension}
* Extension for `mdast-util-to-markdown`.
*/
export function gfmFootnoteToMarkdown() {
return {
// This is on by default already.
unsafe: [{character: '[', inConstruct: ['phrasing', 'label', 'reference']}],
handlers: {footnoteDefinition, footnoteReference}
}
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function enterFootnoteDefinition(token) {
this.enter(
{type: 'footnoteDefinition', identifier: '', label: '', children: []},
token
)
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function enterFootnoteDefinitionLabelString() {
this.buffer()
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function exitFootnoteDefinitionLabelString(token) {
const label = this.resume()
const node = this.stack[this.stack.length - 1]
assert(node.type === 'footnoteDefinition')
node.label = label
node.identifier = normalizeIdentifier(
this.sliceSerialize(token)
).toLowerCase()
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function exitFootnoteDefinition(token) {
this.exit(token)
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function enterFootnoteCall(token) {
this.enter({type: 'footnoteReference', identifier: '', label: ''}, token)
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function enterFootnoteCallString() {
this.buffer()
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function exitFootnoteCallString(token) {
const label = this.resume()
const node = this.stack[this.stack.length - 1]
assert(node.type === 'footnoteReference')
node.label = label
node.identifier = normalizeIdentifier(
this.sliceSerialize(token)
).toLowerCase()
}
/**
* @this {CompileContext}
* @type {FromMarkdownHandle}
*/
function exitFootnoteCall(token) {
this.exit(token)
}
/**
* @type {ToMarkdownHandle}
* @param {FootnoteReference} node
*/
function footnoteReference(node, _, state, info) {
const tracker = state.createTracker(info)
let value = tracker.move('[^')
const exit = state.enter('footnoteReference')
const subexit = state.enter('reference')
value += tracker.move(
state.safe(state.associationId(node), {
...tracker.current(),
before: value,
after: ']'
})
)
subexit()
exit()
value += tracker.move(']')
return value
}
/** @type {ToMarkdownHandle} */
function footnoteReferencePeek() {
return '['
}
/**
* @type {ToMarkdownHandle}
* @param {FootnoteDefinition} node
*/
function footnoteDefinition(node, _, state, info) {
const tracker = state.createTracker(info)
let value = tracker.move('[^')
const exit = state.enter('footnoteDefinition')
const subexit = state.enter('label')
value += tracker.move(
state.safe(state.associationId(node), {
...tracker.current(),
before: value,
after: ']'
})
)
subexit()
value += tracker.move(
']:' + (node.children && node.children.length > 0 ? ' ' : '')
)
tracker.shift(4)
value += tracker.move(
state.indentLines(state.containerFlow(node, tracker.current()), map)
)
exit()
return value
}
/** @type {Map} */
function map(line, index, blank) {
if (index === 0) {
return line
}
return (blank ? '' : ' ') + line
}

22
node_modules/mdast-util-gfm-footnote/license generated vendored Normal file
View File

@@ -0,0 +1,22 @@
(The MIT License)
Copyright (c) 2021 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.

96
node_modules/mdast-util-gfm-footnote/package.json generated vendored Normal file
View File

@@ -0,0 +1,96 @@
{
"name": "mdast-util-gfm-footnote",
"version": "2.0.0",
"description": "mdast extension to parse and serialize GFM footnotes",
"license": "MIT",
"keywords": [
"unist",
"mdast",
"mdast-util",
"util",
"utility",
"markdown",
"markup",
"gfm",
"footnote",
"note"
],
"repository": "syntax-tree/mdast-util-gfm-footnote",
"bugs": "https://github.com/syntax-tree/mdast-util-gfm-footnote/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",
"exports": "./index.js",
"files": [
"lib/",
"index.d.ts",
"index.js"
],
"dependencies": {
"@types/mdast": "^4.0.0",
"devlop": "^1.1.0",
"mdast-util-from-markdown": "^2.0.0",
"mdast-util-to-markdown": "^2.0.0",
"micromark-util-normalize-identifier": "^2.0.0"
},
"devDependencies": {
"@types/node": "^20.0.0",
"c8": "^8.0.0",
"micromark-extension-gfm-footnote": "^2.0.0",
"prettier": "^2.0.0",
"remark-cli": "^11.0.0",
"remark-preset-wooorm": "^9.0.0",
"type-coverage": "^2.0.0",
"typescript": "^5.0.0",
"xo": "^0.54.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-dev": "node --conditions development test.js",
"test-api-prod": "node --conditions production test.js",
"test-api": "npm run test-api-dev && npm run test-api-prod",
"test-coverage": "c8 --100 --reporter lcov npm run test-api",
"test": "npm run build && npm run format && npm run test-coverage"
},
"prettier": {
"bracketSpacing": false,
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "none",
"useTabs": false
},
"remarkConfig": {
"plugins": [
"remark-preset-wooorm"
]
},
"typeCoverage": {
"atLeast": 100,
"detail": true,
"ignoreCatch": true,
"strict": true
},
"xo": {
"overrides": [
{
"files": [
"**/*.ts"
],
"rules": {
"@typescript-eslint/consistent-type-definitions": "off"
}
}
],
"prettier": true
}
}

431
node_modules/mdast-util-gfm-footnote/readme.md generated vendored Normal file
View File

@@ -0,0 +1,431 @@
# mdast-util-gfm-footnote
[![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][] footnotes.
## Contents
* [What is this?](#what-is-this)
* [When to use this](#when-to-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`gfmFootnoteFromMarkdown()`](#gfmfootnotefrommarkdown)
* [`gfmFootnoteToMarkdown()`](#gfmfootnotetomarkdown)
* [HTML](#html)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Nodes](#nodes)
* [Content model](#content-model)
* [Types](#types)
* [Compatibility](#compatibility)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package contains two extensions that add support for GFM footnote syntax
in markdown to [mdast][].
These extensions plug into
[`mdast-util-from-markdown`][mdast-util-from-markdown] (to support parsing
footnotes in markdown into a syntax tree) and
[`mdast-util-to-markdown`][mdast-util-to-markdown] (to support serializing
footnotes in syntax trees to markdown).
GFM footnotes were [announced September 30, 2021][post] but are not specified.
Their implementation on github.com is currently buggy.
The bugs have been reported on [`cmark-gfm`][cmark-gfm].
## 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-footnote`][micromark-extension-gfm-footnote].
When you dont need a syntax tree, you can use [`micromark`][micromark]
directly with `micromark-extension-gfm-footnote`.
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.
Thats done by [`mdast-util-to-hast`][mdast-util-to-hast].
If your content is not in English, you should configure that utility.
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install mdast-util-gfm-footnote
```
In Deno with [`esm.sh`][esmsh]:
```js
import {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from 'https://esm.sh/mdast-util-gfm-footnote@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from 'https://esm.sh/mdast-util-gfm-footnote@2?bundle'
</script>
```
## Use
Say our document `example.md` contains:
```markdown
Hi![^1]
[^1]: big note
```
…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 {gfmFootnote} from 'micromark-extension-gfm-footnote'
import {gfmFootnoteFromMarkdown, gfmFootnoteToMarkdown} from 'mdast-util-gfm-footnote'
const doc = await fs.readFile('example.md')
const tree = fromMarkdown(doc, {
extensions: [gfmFootnote()],
mdastExtensions: [gfmFootnoteFromMarkdown()]
})
console.log(tree)
const out = toMarkdown(tree, {extensions: [gfmFootnoteToMarkdown()]})
console.log(out)
```
…now running `node example.js` yields (positional info removed for brevity):
```js
{
type: 'root',
children: [
{
type: 'paragraph',
children: [
{type: 'text', value: 'Hi!'},
{type: 'footnoteReference', identifier: '1', label: '1'}
]
},
{
type: 'footnoteDefinition',
identifier: '1',
label: '1',
children: [
{type: 'paragraph', children: [{type: 'text', value: 'big note'}]}
]
}
]
}
```
```markdown
Hi\![^1]
[^1]: big note
```
## API
This package exports the identifiers
[`gfmFootnoteFromMarkdown`][api-gfmfootnotefrommarkdown] and
[`gfmFootnoteToMarkdown`][api-gfmfootnotetomarkdown].
There is no default export.
### `gfmFootnoteFromMarkdown()`
Create an extension for
[`mdast-util-from-markdown`][mdast-util-from-markdown]
to enable GFM footnotes in markdown.
###### Returns
Extension for `mdast-util-from-markdown`
([`FromMarkdownExtension`][frommarkdownextension]).
### `gfmFootnoteToMarkdown()`
Create an extension for
[`mdast-util-to-markdown`][mdast-util-to-markdown]
to enable GFM footnotes in markdown.
###### Returns
Extension for `mdast-util-to-markdown`
([`ToMarkdownExtension`][tomarkdownextension]).
## HTML
This utility does not handle how markdown is turned to HTML.
Thats done by [`mdast-util-to-hast`][mdast-util-to-hast].
If your content is not in English, you should configure that utility.
## Syntax
See [Syntax in `micromark-extension-gfm-footnote`][syntax].
## Syntax tree
The following interfaces are added to **[mdast][]** by this utility.
### Nodes
#### `FootnoteDefinition`
```idl
interface FootnoteDefinition <: Parent {
type: 'footnoteDefinition'
children: [FlowContent]
}
FootnoteDefinition includes Association
```
**FootnoteDefinition** (**[Parent][dfn-parent]**) represents content relating
to the document that is outside its flow.
**FootnoteDefinition** can be used where **[flow][dfn-flow-content]** content
is expected.
Its content model is also **[flow][dfn-flow-content]** content.
**FootnoteDefinition** includes the mixin
**[Association][dfn-mxn-association]**.
**FootnoteDefinition** should be associated with
**[FootnoteReferences][dfn-footnote-reference]**.
For example, the following markdown:
```markdown
[^alpha]: bravo and charlie.
```
Yields:
```js
{
type: 'footnoteDefinition',
identifier: 'alpha',
label: 'alpha',
children: [{
type: 'paragraph',
children: [{type: 'text', value: 'bravo and charlie.'}]
}]
}
```
#### `FootnoteReference`
```idl
interface FootnoteReference <: Node {
type: 'footnoteReference'
}
FootnoteReference includes Association
```
**FootnoteReference** (**[Node][dfn-node]**) represents a marker through
association.
**FootnoteReference** can be used where
**[phrasing][dfn-phrasing-content]** content is expected.
It has no content model.
**FootnoteReference** includes the mixin **[Association][dfn-mxn-association]**.
**FootnoteReference** should be associated with a
**[FootnoteDefinition][dfn-footnote-definition]**.
For example, the following markdown:
```markdown
[^alpha]
```
Yields:
```js
{
type: 'footnoteReference',
identifier: 'alpha',
label: 'alpha'
}
```
### Content model
#### `FlowContent` (GFM footnotes)
```idl
type FlowContentGfm = FootnoteDefinition | FlowContent
```
#### `PhrasingContent` (GFM footnotes)
```idl
type PhrasingContentGfm = FootnoteReference | PhrasingContent
```
## Types
This package is fully typed with [TypeScript][].
It does not export additional types.
The `FootnoteDefinition` and `FootnoteReference` types of the mdast nodes are
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-footnote@^2`, compatible with Node.js 16.
## Related
* [`remark-gfm`][remark-gfm]
— remark plugin to support GFM
* [`mdast-util-gfm`][mdast-util-gfm]
— same but all of GFM (autolink literals, footnotes, strikethrough, tables,
tasklists)
* [`micromark-extension-gfm-footnote`][micromark-extension-gfm-footnote]
— micromark extension to parse GFM footnotes
## 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-footnote/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/mdast-util-gfm-footnote/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm-footnote.svg
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm-footnote
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm-footnote.svg
[downloads]: https://www.npmjs.com/package/mdast-util-gfm-footnote
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-gfm-footnote
[size]: https://bundlejs.com/?q=mdast-util-gfm-footnote
[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/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[mdast]: https://github.com/syntax-tree/mdast
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
[remark-gfm]: https://github.com/remarkjs/remark-gfm
[micromark]: https://github.com/micromark/micromark
[micromark-extension-gfm-footnote]: https://github.com/micromark/micromark-extension-gfm-footnote
[syntax]: https://github.com/micromark/micromark-extension-gfm-footnote#syntax
[gfm]: https://github.github.com/gfm/
[cmark-gfm]: https://github.com/github/cmark-gfm
[post]: https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/
[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
[dfn-parent]: https://github.com/syntax-tree/mdast#parent
[dfn-mxn-association]: https://github.com/syntax-tree/mdast#association
[dfn-node]: https://github.com/syntax-tree/unist#node
[frommarkdownextension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
[tomarkdownextension]: https://github.com/syntax-tree/mdast-util-to-markdown#options
[dfn-flow-content]: #flowcontent-gfm-footnotes
[dfn-phrasing-content]: #phrasingcontent-gfm-footnotes
[dfn-footnote-reference]: #footnotereference
[dfn-footnote-definition]: #footnotedefinition
[api-gfmfootnotefrommarkdown]: #gfmfootnotefrommarkdown
[api-gfmfootnotetomarkdown]: #gfmfootnotetomarkdown