Refactor routing in App component to enhance navigation and improve error handling by integrating dynamic routes and updating the NotFound route.
This commit is contained in:
42
node_modules/micromark-factory-destination/dev/index.d.ts
generated
vendored
Normal file
42
node_modules/micromark-factory-destination/dev/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* Parse destinations.
|
||||
*
|
||||
* ###### Examples
|
||||
*
|
||||
* ```markdown
|
||||
* <a>
|
||||
* <a\>b>
|
||||
* <a b>
|
||||
* <a)>
|
||||
* a
|
||||
* a\)b
|
||||
* a(b)c
|
||||
* a(b)
|
||||
* ```
|
||||
*
|
||||
* @param {Effects} effects
|
||||
* Context.
|
||||
* @param {State} ok
|
||||
* State switched to when successful.
|
||||
* @param {State} nok
|
||||
* State switched to when unsuccessful.
|
||||
* @param {TokenType} type
|
||||
* Type for whole (`<a>` or `b`).
|
||||
* @param {TokenType} literalType
|
||||
* Type when enclosed (`<a>`).
|
||||
* @param {TokenType} literalMarkerType
|
||||
* Type for enclosing (`<` and `>`).
|
||||
* @param {TokenType} rawType
|
||||
* Type when not enclosed (`b`).
|
||||
* @param {TokenType} stringType
|
||||
* Type for the value (`a` or `b`).
|
||||
* @param {number | undefined} [max=Infinity]
|
||||
* Depth of nested parens (inclusive).
|
||||
* @returns {State}
|
||||
* Start state.
|
||||
*/
|
||||
export function factoryDestination(effects: Effects, ok: State, nok: State, type: TokenType, literalType: TokenType, literalMarkerType: TokenType, rawType: TokenType, stringType: TokenType, max?: number | undefined): State;
|
||||
import type { Effects } from 'micromark-util-types';
|
||||
import type { State } from 'micromark-util-types';
|
||||
import type { TokenType } from 'micromark-util-types';
|
||||
//# sourceMappingURL=index.d.ts.map
|
1
node_modules/micromark-factory-destination/dev/index.d.ts.map
generated
vendored
Normal file
1
node_modules/micromark-factory-destination/dev/index.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,4CArBW,OAAO,MAEP,KAAK,OAEL,KAAK,QAEL,SAAS,eAET,SAAS,qBAET,SAAS,WAET,SAAS,cAET,SAAS,QAET,MAAM,GAAG,SAAS,GAEhB,KAAK,CAiNjB;6BA7P2C,sBAAsB;2BAAtB,sBAAsB;+BAAtB,sBAAsB"}
|
255
node_modules/micromark-factory-destination/dev/index.js
generated
vendored
Normal file
255
node_modules/micromark-factory-destination/dev/index.js
generated
vendored
Normal file
@@ -0,0 +1,255 @@
|
||||
/**
|
||||
* @import {Effects, State, TokenType} from 'micromark-util-types'
|
||||
*/
|
||||
|
||||
import {
|
||||
asciiControl,
|
||||
markdownLineEndingOrSpace,
|
||||
markdownLineEnding
|
||||
} from 'micromark-util-character'
|
||||
import {codes, constants, types} from 'micromark-util-symbol'
|
||||
|
||||
/**
|
||||
* Parse destinations.
|
||||
*
|
||||
* ###### Examples
|
||||
*
|
||||
* ```markdown
|
||||
* <a>
|
||||
* <a\>b>
|
||||
* <a b>
|
||||
* <a)>
|
||||
* a
|
||||
* a\)b
|
||||
* a(b)c
|
||||
* a(b)
|
||||
* ```
|
||||
*
|
||||
* @param {Effects} effects
|
||||
* Context.
|
||||
* @param {State} ok
|
||||
* State switched to when successful.
|
||||
* @param {State} nok
|
||||
* State switched to when unsuccessful.
|
||||
* @param {TokenType} type
|
||||
* Type for whole (`<a>` or `b`).
|
||||
* @param {TokenType} literalType
|
||||
* Type when enclosed (`<a>`).
|
||||
* @param {TokenType} literalMarkerType
|
||||
* Type for enclosing (`<` and `>`).
|
||||
* @param {TokenType} rawType
|
||||
* Type when not enclosed (`b`).
|
||||
* @param {TokenType} stringType
|
||||
* Type for the value (`a` or `b`).
|
||||
* @param {number | undefined} [max=Infinity]
|
||||
* Depth of nested parens (inclusive).
|
||||
* @returns {State}
|
||||
* Start state.
|
||||
*/
|
||||
export function factoryDestination(
|
||||
effects,
|
||||
ok,
|
||||
nok,
|
||||
type,
|
||||
literalType,
|
||||
literalMarkerType,
|
||||
rawType,
|
||||
stringType,
|
||||
max
|
||||
) {
|
||||
const limit = max || Number.POSITIVE_INFINITY
|
||||
let balance = 0
|
||||
|
||||
return start
|
||||
|
||||
/**
|
||||
* Start of destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* > | aa
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function start(code) {
|
||||
if (code === codes.lessThan) {
|
||||
effects.enter(type)
|
||||
effects.enter(literalType)
|
||||
effects.enter(literalMarkerType)
|
||||
effects.consume(code)
|
||||
effects.exit(literalMarkerType)
|
||||
return enclosedBefore
|
||||
}
|
||||
|
||||
// ASCII control, space, closing paren.
|
||||
if (
|
||||
code === codes.eof ||
|
||||
code === codes.space ||
|
||||
code === codes.rightParenthesis ||
|
||||
asciiControl(code)
|
||||
) {
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
effects.enter(type)
|
||||
effects.enter(rawType)
|
||||
effects.enter(stringType)
|
||||
effects.enter(types.chunkString, {contentType: constants.contentTypeString})
|
||||
return raw(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* After `<`, at an enclosed destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosedBefore(code) {
|
||||
if (code === codes.greaterThan) {
|
||||
effects.enter(literalMarkerType)
|
||||
effects.consume(code)
|
||||
effects.exit(literalMarkerType)
|
||||
effects.exit(literalType)
|
||||
effects.exit(type)
|
||||
return ok
|
||||
}
|
||||
|
||||
effects.enter(stringType)
|
||||
effects.enter(types.chunkString, {contentType: constants.contentTypeString})
|
||||
return enclosed(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* In enclosed destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosed(code) {
|
||||
if (code === codes.greaterThan) {
|
||||
effects.exit(types.chunkString)
|
||||
effects.exit(stringType)
|
||||
return enclosedBefore(code)
|
||||
}
|
||||
|
||||
if (
|
||||
code === codes.eof ||
|
||||
code === codes.lessThan ||
|
||||
markdownLineEnding(code)
|
||||
) {
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
effects.consume(code)
|
||||
return code === codes.backslash ? enclosedEscape : enclosed
|
||||
}
|
||||
|
||||
/**
|
||||
* After `\`, at a special character.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <a\*a>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosedEscape(code) {
|
||||
if (
|
||||
code === codes.lessThan ||
|
||||
code === codes.greaterThan ||
|
||||
code === codes.backslash
|
||||
) {
|
||||
effects.consume(code)
|
||||
return enclosed
|
||||
}
|
||||
|
||||
return enclosed(code)
|
||||
}
|
||||
|
||||
/**
|
||||
* In raw destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | aa
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function raw(code) {
|
||||
if (
|
||||
!balance &&
|
||||
(code === codes.eof ||
|
||||
code === codes.rightParenthesis ||
|
||||
markdownLineEndingOrSpace(code))
|
||||
) {
|
||||
effects.exit(types.chunkString)
|
||||
effects.exit(stringType)
|
||||
effects.exit(rawType)
|
||||
effects.exit(type)
|
||||
return ok(code)
|
||||
}
|
||||
|
||||
if (balance < limit && code === codes.leftParenthesis) {
|
||||
effects.consume(code)
|
||||
balance++
|
||||
return raw
|
||||
}
|
||||
|
||||
if (code === codes.rightParenthesis) {
|
||||
effects.consume(code)
|
||||
balance--
|
||||
return raw
|
||||
}
|
||||
|
||||
// ASCII control (but *not* `\0`) and space and `(`.
|
||||
// Note: in `markdown-rs`, `\0` exists in codes, in `micromark-js` it
|
||||
// doesn’t.
|
||||
if (
|
||||
code === codes.eof ||
|
||||
code === codes.space ||
|
||||
code === codes.leftParenthesis ||
|
||||
asciiControl(code)
|
||||
) {
|
||||
return nok(code)
|
||||
}
|
||||
|
||||
effects.consume(code)
|
||||
return code === codes.backslash ? rawEscape : raw
|
||||
}
|
||||
|
||||
/**
|
||||
* After `\`, at special character.
|
||||
*
|
||||
* ```markdown
|
||||
* > | a\*a
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function rawEscape(code) {
|
||||
if (
|
||||
code === codes.leftParenthesis ||
|
||||
code === codes.rightParenthesis ||
|
||||
code === codes.backslash
|
||||
) {
|
||||
effects.consume(code)
|
||||
return raw
|
||||
}
|
||||
|
||||
return raw(code)
|
||||
}
|
||||
}
|
42
node_modules/micromark-factory-destination/index.d.ts
generated
vendored
Normal file
42
node_modules/micromark-factory-destination/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
/**
|
||||
* Parse destinations.
|
||||
*
|
||||
* ###### Examples
|
||||
*
|
||||
* ```markdown
|
||||
* <a>
|
||||
* <a\>b>
|
||||
* <a b>
|
||||
* <a)>
|
||||
* a
|
||||
* a\)b
|
||||
* a(b)c
|
||||
* a(b)
|
||||
* ```
|
||||
*
|
||||
* @param {Effects} effects
|
||||
* Context.
|
||||
* @param {State} ok
|
||||
* State switched to when successful.
|
||||
* @param {State} nok
|
||||
* State switched to when unsuccessful.
|
||||
* @param {TokenType} type
|
||||
* Type for whole (`<a>` or `b`).
|
||||
* @param {TokenType} literalType
|
||||
* Type when enclosed (`<a>`).
|
||||
* @param {TokenType} literalMarkerType
|
||||
* Type for enclosing (`<` and `>`).
|
||||
* @param {TokenType} rawType
|
||||
* Type when not enclosed (`b`).
|
||||
* @param {TokenType} stringType
|
||||
* Type for the value (`a` or `b`).
|
||||
* @param {number | undefined} [max=Infinity]
|
||||
* Depth of nested parens (inclusive).
|
||||
* @returns {State}
|
||||
* Start state.
|
||||
*/
|
||||
export function factoryDestination(effects: Effects, ok: State, nok: State, type: TokenType, literalType: TokenType, literalMarkerType: TokenType, rawType: TokenType, stringType: TokenType, max?: number | undefined): State;
|
||||
import type { Effects } from 'micromark-util-types';
|
||||
import type { State } from 'micromark-util-types';
|
||||
import type { TokenType } from 'micromark-util-types';
|
||||
//# sourceMappingURL=index.d.ts.map
|
1
node_modules/micromark-factory-destination/index.d.ts.map
generated
vendored
Normal file
1
node_modules/micromark-factory-destination/index.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAWA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,4CArBW,OAAO,MAEP,KAAK,OAEL,KAAK,QAEL,SAAS,eAET,SAAS,qBAET,SAAS,WAET,SAAS,cAET,SAAS,QAET,MAAM,GAAG,SAAS,GAEhB,KAAK,CAiNjB;6BA7P2C,sBAAsB;2BAAtB,sBAAsB;+BAAtB,sBAAsB"}
|
206
node_modules/micromark-factory-destination/index.js
generated
vendored
Normal file
206
node_modules/micromark-factory-destination/index.js
generated
vendored
Normal file
@@ -0,0 +1,206 @@
|
||||
/**
|
||||
* @import {Effects, State, TokenType} from 'micromark-util-types'
|
||||
*/
|
||||
|
||||
import { asciiControl, markdownLineEndingOrSpace, markdownLineEnding } from 'micromark-util-character';
|
||||
/**
|
||||
* Parse destinations.
|
||||
*
|
||||
* ###### Examples
|
||||
*
|
||||
* ```markdown
|
||||
* <a>
|
||||
* <a\>b>
|
||||
* <a b>
|
||||
* <a)>
|
||||
* a
|
||||
* a\)b
|
||||
* a(b)c
|
||||
* a(b)
|
||||
* ```
|
||||
*
|
||||
* @param {Effects} effects
|
||||
* Context.
|
||||
* @param {State} ok
|
||||
* State switched to when successful.
|
||||
* @param {State} nok
|
||||
* State switched to when unsuccessful.
|
||||
* @param {TokenType} type
|
||||
* Type for whole (`<a>` or `b`).
|
||||
* @param {TokenType} literalType
|
||||
* Type when enclosed (`<a>`).
|
||||
* @param {TokenType} literalMarkerType
|
||||
* Type for enclosing (`<` and `>`).
|
||||
* @param {TokenType} rawType
|
||||
* Type when not enclosed (`b`).
|
||||
* @param {TokenType} stringType
|
||||
* Type for the value (`a` or `b`).
|
||||
* @param {number | undefined} [max=Infinity]
|
||||
* Depth of nested parens (inclusive).
|
||||
* @returns {State}
|
||||
* Start state.
|
||||
*/
|
||||
export function factoryDestination(effects, ok, nok, type, literalType, literalMarkerType, rawType, stringType, max) {
|
||||
const limit = max || Number.POSITIVE_INFINITY;
|
||||
let balance = 0;
|
||||
return start;
|
||||
|
||||
/**
|
||||
* Start of destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* > | aa
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function start(code) {
|
||||
if (code === 60) {
|
||||
effects.enter(type);
|
||||
effects.enter(literalType);
|
||||
effects.enter(literalMarkerType);
|
||||
effects.consume(code);
|
||||
effects.exit(literalMarkerType);
|
||||
return enclosedBefore;
|
||||
}
|
||||
|
||||
// ASCII control, space, closing paren.
|
||||
if (code === null || code === 32 || code === 41 || asciiControl(code)) {
|
||||
return nok(code);
|
||||
}
|
||||
effects.enter(type);
|
||||
effects.enter(rawType);
|
||||
effects.enter(stringType);
|
||||
effects.enter("chunkString", {
|
||||
contentType: "string"
|
||||
});
|
||||
return raw(code);
|
||||
}
|
||||
|
||||
/**
|
||||
* After `<`, at an enclosed destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosedBefore(code) {
|
||||
if (code === 62) {
|
||||
effects.enter(literalMarkerType);
|
||||
effects.consume(code);
|
||||
effects.exit(literalMarkerType);
|
||||
effects.exit(literalType);
|
||||
effects.exit(type);
|
||||
return ok;
|
||||
}
|
||||
effects.enter(stringType);
|
||||
effects.enter("chunkString", {
|
||||
contentType: "string"
|
||||
});
|
||||
return enclosed(code);
|
||||
}
|
||||
|
||||
/**
|
||||
* In enclosed destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <aa>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosed(code) {
|
||||
if (code === 62) {
|
||||
effects.exit("chunkString");
|
||||
effects.exit(stringType);
|
||||
return enclosedBefore(code);
|
||||
}
|
||||
if (code === null || code === 60 || markdownLineEnding(code)) {
|
||||
return nok(code);
|
||||
}
|
||||
effects.consume(code);
|
||||
return code === 92 ? enclosedEscape : enclosed;
|
||||
}
|
||||
|
||||
/**
|
||||
* After `\`, at a special character.
|
||||
*
|
||||
* ```markdown
|
||||
* > | <a\*a>
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function enclosedEscape(code) {
|
||||
if (code === 60 || code === 62 || code === 92) {
|
||||
effects.consume(code);
|
||||
return enclosed;
|
||||
}
|
||||
return enclosed(code);
|
||||
}
|
||||
|
||||
/**
|
||||
* In raw destination.
|
||||
*
|
||||
* ```markdown
|
||||
* > | aa
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function raw(code) {
|
||||
if (!balance && (code === null || code === 41 || markdownLineEndingOrSpace(code))) {
|
||||
effects.exit("chunkString");
|
||||
effects.exit(stringType);
|
||||
effects.exit(rawType);
|
||||
effects.exit(type);
|
||||
return ok(code);
|
||||
}
|
||||
if (balance < limit && code === 40) {
|
||||
effects.consume(code);
|
||||
balance++;
|
||||
return raw;
|
||||
}
|
||||
if (code === 41) {
|
||||
effects.consume(code);
|
||||
balance--;
|
||||
return raw;
|
||||
}
|
||||
|
||||
// ASCII control (but *not* `\0`) and space and `(`.
|
||||
// Note: in `markdown-rs`, `\0` exists in codes, in `micromark-js` it
|
||||
// doesn’t.
|
||||
if (code === null || code === 32 || code === 40 || asciiControl(code)) {
|
||||
return nok(code);
|
||||
}
|
||||
effects.consume(code);
|
||||
return code === 92 ? rawEscape : raw;
|
||||
}
|
||||
|
||||
/**
|
||||
* After `\`, at special character.
|
||||
*
|
||||
* ```markdown
|
||||
* > | a\*a
|
||||
* ^
|
||||
* ```
|
||||
*
|
||||
* @type {State}
|
||||
*/
|
||||
function rawEscape(code) {
|
||||
if (code === 40 || code === 41 || code === 92) {
|
||||
effects.consume(code);
|
||||
return raw;
|
||||
}
|
||||
return raw(code);
|
||||
}
|
||||
}
|
22
node_modules/micromark-factory-destination/license
generated
vendored
Normal file
22
node_modules/micromark-factory-destination/license
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 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.
|
57
node_modules/micromark-factory-destination/package.json
generated
vendored
Normal file
57
node_modules/micromark-factory-destination/package.json
generated
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
{
|
||||
"name": "micromark-factory-destination",
|
||||
"version": "2.0.1",
|
||||
"description": "micromark factory to parse destinations (found in resources, definitions)",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"micromark",
|
||||
"factory",
|
||||
"destination"
|
||||
],
|
||||
"repository": "https://github.com/micromark/micromark/tree/main/packages/micromark-factory-destination",
|
||||
"bugs": "https://github.com/micromark/micromark/issues",
|
||||
"funding": [
|
||||
{
|
||||
"type": "GitHub Sponsors",
|
||||
"url": "https://github.com/sponsors/unifiedjs"
|
||||
},
|
||||
{
|
||||
"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",
|
||||
"files": [
|
||||
"dev/",
|
||||
"index.d.ts.map",
|
||||
"index.d.ts",
|
||||
"index.js"
|
||||
],
|
||||
"exports": {
|
||||
"development": "./dev/index.js",
|
||||
"default": "./index.js"
|
||||
},
|
||||
"dependencies": {
|
||||
"micromark-util-character": "^2.0.0",
|
||||
"micromark-util-symbol": "^2.0.0",
|
||||
"micromark-util-types": "^2.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"build": "micromark-build"
|
||||
},
|
||||
"xo": {
|
||||
"envs": [
|
||||
"shared-node-browser"
|
||||
],
|
||||
"prettier": true,
|
||||
"rules": {
|
||||
"max-params": "off",
|
||||
"unicorn/prefer-code-point": "off"
|
||||
}
|
||||
}
|
||||
}
|
234
node_modules/micromark-factory-destination/readme.md
generated
vendored
Normal file
234
node_modules/micromark-factory-destination/readme.md
generated
vendored
Normal file
@@ -0,0 +1,234 @@
|
||||
# micromark-factory-destination
|
||||
|
||||
[![Build][build-badge]][build]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Downloads][downloads-badge]][downloads]
|
||||
[![Size][bundle-size-badge]][bundle-size]
|
||||
[![Sponsors][sponsors-badge]][opencollective]
|
||||
[![Backers][backers-badge]][opencollective]
|
||||
[![Chat][chat-badge]][chat]
|
||||
|
||||
[micromark][] factory to parse destinations (found in resources, definitions).
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When should I use this?](#when-should-i-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`factoryDestination(…)`](#factorydestination)
|
||||
* [Types](#types)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Security](#security)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## What is this?
|
||||
|
||||
This package exposes states to parse destinations.
|
||||
|
||||
## When should I use this?
|
||||
|
||||
This package is useful when you are making your own micromark extensions.
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 16+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install micromark-factory-destination
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {factoryDestination} from 'https://esm.sh/micromark-factory-destination@1'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {factoryDestination} from 'https://esm.sh/micromark-factory-destination@1?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
```js
|
||||
import {factoryDestination} from 'micromark-factory-destination'
|
||||
import {codes, types} from 'micromark-util-symbol'
|
||||
|
||||
// A micromark tokenizer that uses the factory:
|
||||
/**
|
||||
* @this {TokenizeContext}
|
||||
* Context.
|
||||
* @type {Tokenizer}
|
||||
*/
|
||||
function tokenizeResource(effects, ok, nok) {
|
||||
return start
|
||||
|
||||
// …
|
||||
|
||||
/** @type {State} */
|
||||
function open(code) {
|
||||
if (code === codes.rightParenthesis) {
|
||||
return end(code)
|
||||
}
|
||||
|
||||
return factoryDestination(
|
||||
effects,
|
||||
destinationAfter,
|
||||
nok,
|
||||
types.resourceDestination,
|
||||
types.resourceDestinationLiteral,
|
||||
types.resourceDestinationLiteralMarker,
|
||||
types.resourceDestinationRaw,
|
||||
types.resourceDestinationString,
|
||||
constants.linkResourceDestinationBalanceMax
|
||||
)(code)
|
||||
}
|
||||
|
||||
// …
|
||||
}
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This module exports the identifier
|
||||
[`factoryDestination`][api-factory-destination].
|
||||
There is no default export.
|
||||
|
||||
### `factoryDestination(…)`
|
||||
|
||||
Parse destinations.
|
||||
|
||||
###### Examples
|
||||
|
||||
```markdown
|
||||
<a>
|
||||
<a\>b>
|
||||
<a b>
|
||||
<a)>
|
||||
a
|
||||
a\)b
|
||||
a(b)c
|
||||
a(b)
|
||||
```
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `effects` (`Effects`)
|
||||
— context
|
||||
* `ok` (`State`)
|
||||
— state switched to when successful
|
||||
* `nok` (`State`)
|
||||
— state switched to when unsuccessful
|
||||
* `type` (`string`)
|
||||
— type for whole (`<a>` or `b`)
|
||||
* `literalType` (`string`)
|
||||
— type when enclosed (`<a>`)
|
||||
* `literalMarkerType` (`string`)
|
||||
— type for enclosing (`<` and `>`)
|
||||
* `rawType` (`string`)
|
||||
— type when not enclosed (`b`)
|
||||
* `stringType` (`string`)
|
||||
— type for the value (`a` or `b`)
|
||||
* `max` (`number`, default: `Infinity`)
|
||||
— depth of nested parens (inclusive)
|
||||
|
||||
###### Returns
|
||||
|
||||
Start state (`State`).
|
||||
|
||||
## Types
|
||||
|
||||
This package is fully typed with [TypeScript][].
|
||||
It exports no additional types.
|
||||
|
||||
## 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,
|
||||
`micromark-factory-destination@2`, compatible with Node.js 16.
|
||||
This package works with `micromark@3`.
|
||||
|
||||
## Security
|
||||
|
||||
This package is safe.
|
||||
See [`security.md`][securitymd] in [`micromark/.github`][health] for how to
|
||||
submit a security report.
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md`][contributing] in [`micromark/.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, organisation, or community you agree to
|
||||
abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
[MIT][license] © [Titus Wormer][author]
|
||||
|
||||
<!-- Definitions -->
|
||||
|
||||
[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/micromark/micromark/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/micromark/micromark
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/micromark-factory-destination.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/micromark-factory-destination
|
||||
|
||||
[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-factory-destination
|
||||
|
||||
[bundle-size]: https://bundlejs.com/?q=micromark-factory-destination
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[opencollective]: https://opencollective.com/unified
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[chat]: https://github.com/micromark/micromark/discussions
|
||||
|
||||
[license]: https://github.com/micromark/micromark/blob/main/license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[health]: https://github.com/micromark/.github
|
||||
|
||||
[securitymd]: https://github.com/micromark/.github/blob/main/security.md
|
||||
|
||||
[contributing]: https://github.com/micromark/.github/blob/main/contributing.md
|
||||
|
||||
[support]: https://github.com/micromark/.github/blob/main/support.md
|
||||
|
||||
[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
|
||||
[micromark]: https://github.com/micromark/micromark
|
||||
|
||||
[api-factory-destination]: #factorydestination
|
Reference in New Issue
Block a user