sidski/kjelsrud.dev
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

🎉 initiate project *astro_rewrite*

Browse source
This commit is contained in:
sindrekjelsrud 2023-07-19 21:31:30 +02:00
parent ffd4d5e86c
commit 2ba37bfbe3
8658 changed files with 2268794 additions and 2538 deletions
Download patch file Download diff file Expand all files Collapse all files

863
node_modules/unified/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,863 @@
// TypeScript Version: 4.0
// Note: this is a `.d.ts` file because it is not possible to have default type
// parameters in JSDoc-based TypeScript, which is a feature we use to type that:
//
// ```js
// .use(somePlugin, theOptions)
// ```
//
// `theOptions` matches the options that `somePlugin` expects and thus is very
// important for making unified usable in TypeScript.
//
// Furthermore, this is places in the root of the project because types that
// accept type parameters cannot be re-exported as such easily.
import {Node} from 'unist'
import {VFile, VFileCompatible} from 'vfile'
/* eslint-disable @typescript-eslint/naming-convention */
type VFileWithOutput<Result> = Result extends Uint8Array // Buffer.
? VFile
: Result extends object // Custom result type
? VFile & {result: Result}
: VFile
// Get the right most non-void thing.
type Specific<Left = void, Right = void> = Right extends void ? Left : Right
// Create a processor based on the input/output of a plugin.
type UsePlugin<
ParseTree extends Node | void = void,
CurrentTree extends Node | void = void,
CompileTree extends Node | void = void,
CompileResult = void,
Input = void,
Output = void
> = Output extends Node
? Input extends string
? // If `Input` is `string` and `Output` is `Node`, then this plugin
// defines a parser, so set `ParseTree`.
Processor<
Output,
Specific<Output, CurrentTree>,
Specific<Output, CompileTree>,
CompileResult
>
: Input extends Node
? // If `Input` is `Node` and `Output` is `Node`, then this plugin defines a
// transformer, its output defines the input of the next, so set
// `CurrentTree`.
Processor<
Specific<Input, ParseTree>,
Output,
Specific<CompileTree, Output>,
CompileResult
>
: // Else, `Input` is something else and `Output` is `Node`:
never
: Input extends Node
? // If `Input` is `Node` and `Output` is not a `Node`, then this plugin
// defines a compiler, so set `CompileTree` and `CompileResult`
Processor<
Specific<Input, ParseTree>,
Specific<Input, CurrentTree>,
Input,
Output
>
: // Else, `Input` is not a `Node` and `Output` is not a `Node`.
// Maybe it’s untyped, or the plugin throws an error (`never`), so lets
// just keep it as it was.
Processor<ParseTree, CurrentTree, CompileTree, CompileResult>
/* eslint-enable @typescript-eslint/naming-convention */
/**
* Processor allows plugins to be chained together to transform content.
* The chain of plugins defines how content flows through it.
*
* @typeParam ParseTree
* The node that the parser yields (and `run` receives).
* @typeParam CurrentTree
* The node that the last attached plugin yields.
* @typeParam CompileTree
* The node that the compiler receives (and `run` yields).
* @typeParam CompileResult
* The thing that the compiler yields.
*/
export interface Processor<
ParseTree extends Node | void = void,
CurrentTree extends Node | void = void,
CompileTree extends Node | void = void,
CompileResult = void
> extends FrozenProcessor<ParseTree, CurrentTree, CompileTree, CompileResult> {
/**
* Configure the processor to use a plugin.
*
* @typeParam PluginParameters
* Plugin settings.
* @typeParam Input
* Value that is accepted by the plugin.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer expects.
* * If the plugin sets a parser, then this should be `string`.
* * If the plugin sets a compiler, then this should be the node type that
* the compiler expects.
* @typeParam Output
* Value that the plugin yields.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer yields, and defaults to `Input`.
* * If the plugin sets a parser, then this should be the node type that
* the parser yields.
* * If the plugin sets a compiler, then this should be the result that
* the compiler yields (`string`, `Buffer`, or something else).
* @param plugin
* Plugin (function) to use.
* Plugins are deduped based on identity: passing a function in twice will
* cause it to run only once.
* @param settings
* Configuration for plugin, optional.
* Plugins typically receive one options object, but could receive other and
* more values.
* It’s also possible to pass a boolean instead of settings: `true` (to turn
* a plugin on) or `false` (to turn a plugin off).
* @returns
* Current processor.
*/
use<
PluginParameters extends any[] = any[],
Input = Specific<Node, CurrentTree>,
Output = Input
>(
plugin: Plugin<PluginParameters, Input, Output>,
...settings: PluginParameters | [boolean]
): UsePlugin<
ParseTree,
CurrentTree,
CompileTree,
CompileResult,
Input,
Output
>
/**
* Configure the processor with a tuple of a plugin and setting(s).
*
* @typeParam PluginParameters
* Plugin settings.
* @typeParam Input
* Value that is accepted by the plugin.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer expects.
* * If the plugin sets a parser, then this should be `string`.
* * If the plugin sets a compiler, then this should be the node type that
* the compiler expects.
* @typeParam Output
* Value that the plugin yields.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer yields, and defaults to `Input`.
* * If the plugin sets a parser, then this should be the node type that
* the parser yields.
* * If the plugin sets a compiler, then this should be the result that
* the compiler yields (`string`, `Buffer`, or something else).
* @param tuple
* A tuple where the first item is a plugin (function) to use and other
* items are options.
* Plugins are deduped based on identity: passing a function in twice will
* cause it to run only once.
* It’s also possible to pass a boolean instead of settings: `true` (to turn
* a plugin on) or `false` (to turn a plugin off).
* @returns
* Current processor.
*/
use<
PluginParameters extends any[] = any[],
Input = Specific<Node, CurrentTree>,
Output = Input
>(
tuple:
| PluginTuple<PluginParameters, Input, Output>
| [Plugin<PluginParameters, Input, Output>, boolean]
): UsePlugin<
ParseTree,
CurrentTree,
CompileTree,
CompileResult,
Input,
Output
>
/**
* Configure the processor with a preset or list of plugins and presets.
*
* @param presetOrList
* Either a list of plugins, presets, and tuples, or a single preset: an
* object with a `plugins` (list) and/or `settings`
* (`Record<string, unknown>`).
* @returns
* Current processor.
*/
use(
presetOrList: Preset | PluggableList
): Processor<ParseTree, CurrentTree, CompileTree, CompileResult>
}
/**
* A frozen processor is just like a regular processor, except no additional
* plugins can be added.
* A frozen processor can be created by calling `.freeze()` on a processor.
* An unfrozen processor can be created by calling a processor.
*/
export interface FrozenProcessor<
ParseTree extends Node | void = void,
CurrentTree extends Node | void = void,
CompileTree extends Node | void = void,
CompileResult = void
> {
/**
* Clone current processor
*
* @returns
* New unfrozen processor that is configured to function the same as its
* ancestor.
* But when the descendant processor is configured it does not affect the
* ancestral processor.
*/
(): Processor<ParseTree, CurrentTree, CompileTree, CompileResult>
/**
* Internal list of configured plugins.
*
* @private
*/
attachers: Array<[Plugin, ...unknown[]]>
Parser?: Parser<Specific<Node, ParseTree>> | undefined
Compiler?:
| Compiler<Specific<Node, CompileTree>, Specific<unknown, CompileResult>>
| undefined
/**
* Parse a file.
*
* @param file
* File to parse.
* `VFile` or anything that can be given to `new VFile()`, optional.
* @returns
* Resulting tree.
*/
parse(file?: VFileCompatible | undefined): Specific<Node, ParseTree>
/**
* Compile a file.
*
* @param node
* Node to compile.
* @param file
* `VFile` or anything that can be given to `new VFile()`, optional.
* @returns
* New content: compiled text (`string` or `Buffer`) or something else.
* This depends on which plugins you use: typically text, but could for
* example be a React node.
*/
stringify(
node: Specific<Node, CompileTree>,
file?: VFileCompatible | undefined
): CompileTree extends Node ? CompileResult : unknown
/**
* Run transforms on the given tree.
*
* @param node
* Tree to transform.
* @param callback
* Callback called with an error or the resulting node.
* @returns
* Nothing.
*/
run(
node: Specific<Node, ParseTree>,
callback: RunCallback<Specific<Node, CompileTree>>
): void
/**
* Run transforms on the given node.
*
* @param node
* Tree to transform.
* @param file
* File associated with `node`.
* `VFile` or anything that can be given to `new VFile()`.
* @param callback
* Callback called with an error or the resulting node.
* @returns
* Nothing.
*/
run(
node: Specific<Node, ParseTree>,
file: VFileCompatible | undefined,
callback: RunCallback<Specific<Node, CompileTree>>
): void
/**
* Run transforms on the given node.
*
* @param node
* Tree to transform.
* @param file
* File associated with `node`.
* `VFile` or anything that can be given to `new VFile()`.
* @returns
* Promise that resolves to the resulting tree.
*/
run(
node: Specific<Node, ParseTree>,
file?: VFileCompatible | undefined
): Promise<Specific<Node, CompileTree>>
/**
* Run transforms on the given node, synchronously.
* Throws when asynchronous transforms are configured.
*
* @param node
* Tree to transform.
* @param file
* File associated with `node`.
* `VFile` or anything that can be given to `new VFile()`, optional.
* @returns
* Resulting tree.
*/
runSync(
node: Specific<Node, ParseTree>,
file?: VFileCompatible | undefined
): Specific<Node, CompileTree>
/**
* Process a file.
*
* This performs all phases of the processor:
*
* 1. Parse a file into a unist node using the configured `Parser`
* 2. Run transforms on that node
* 3. Compile the resulting node using the `Compiler`
*
* The result from the compiler is stored on the file.
* What the result is depends on which plugins you use.
* The result is typically text (`string` or `Buffer`), which can be retrieved
* with `file.toString()` (or `String(file)`).
* In some cases, such as when using `rehypeReact` to create a React node,
* the result is stored on `file.result`.
*
* @param file
* `VFile` or anything that can be given to `new VFile()`.
* @param callback
* Callback called with an error or the resulting file.
* @returns
* Nothing.
*/
process(
file: VFileCompatible | undefined,
callback: ProcessCallback<VFileWithOutput<CompileResult>>
): void
/**
* Process a file.
*
* This performs all phases of the processor:
*
* 1. Parse a file into a unist node using the configured `Parser`
* 2. Run transforms on that node
* 3. Compile the resulting node using the `Compiler`
*
* The result from the compiler is stored on the file.
* What the result is depends on which plugins you use.
* The result is typically text (`string` or `Buffer`), which can be retrieved
* with `file.toString()` (or `String(file)`).
* In some cases, such as when using `rehypeReact` to create a React node,
* the result is stored on `file.result`.
*
* @param file
* `VFile` or anything that can be given to `new VFile()`.
* @returns
* Promise that resolves to the resulting `VFile`.
*/
process(file: VFileCompatible): Promise<VFileWithOutput<CompileResult>>
/**
* Process a file, synchronously.
* Throws when asynchronous transforms are configured.
*
* This performs all phases of the processor:
*
* 1. Parse a file into a unist node using the configured `Parser`
* 2. Run transforms on that node
* 3. Compile the resulting node using the `Compiler`
*
* The result from the compiler is stored on the file.
* What the result is depends on which plugins you use.
* The result is typically text (`string` or `Buffer`), which can be retrieved
* with `file.toString()` (or `String(file)`).
* In some cases, such as when using `rehypeReact` to create a React node,
* the result is stored on `file.result`.
*
* @param file
* `VFile` or anything that can be given to `new VFile()`, optional.
* @returns
* Resulting file.
*/
processSync(
file?: VFileCompatible | undefined
): VFileWithOutput<CompileResult>
/**
* Get an in-memory key-value store accessible to all phases of the process.
*
* @returns
* Key-value store.
*/
data(): Record<string, unknown>
/**
* Set an in-memory key-value store accessible to all phases of the process.
*
* @param data
* Key-value store.
* @returns
* Current processor.
*/
data(
data: Record<string, unknown>
): Processor<ParseTree, CurrentTree, CompileTree, CompileResult>
/**
* Get an in-memory value by key.
*
* @param key
* Key to get.
* @returns
* The value at `key`.
*/
data(key: string): unknown
/**
* Set an in-memory value by key.
*
* @param key
* Key to set.
* @param value
* Value to set.
* @returns
* Current processor.
*/
data(
key: string,
value: unknown
): Processor<ParseTree, CurrentTree, CompileTree, CompileResult>
/**
* Freeze a processor.
* Frozen processors are meant to be extended and not to be configured or
* processed directly.
*
* Once a processor is frozen it cannot be unfrozen.
* New processors working just like it can be created by calling the
* processor.
*
* It’s possible to freeze processors explicitly, by calling `.freeze()`, but
* `.parse()`, `.run()`, `.stringify()`, and `.process()` call `.freeze()` to
* freeze a processor too.
*
* @returns
* Frozen processor.
*/
freeze(): FrozenProcessor<ParseTree, CurrentTree, CompileTree, CompileResult>
}
/**
* A plugin is a function.
* It configures the processor and in turn can receive options.
* Plugins can configure processors by interacting with parsers and compilers
* (at `this.Parser` or `this.Compiler`) or by specifying how the syntax tree
* is handled (by returning a `Transformer`).
*
* @typeParam PluginParameters
* Plugin settings.
* @typeParam Input
* Value that is accepted by the plugin.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer expects.
* * If the plugin sets a parser, then this should be `string`.
* * If the plugin sets a compiler, then this should be the node type that
* the compiler expects.
* @typeParam Output
* Value that the plugin yields.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer yields, and defaults to `Input`.
* * If the plugin sets a parser, then this should be the node type that
* the parser yields.
* * If the plugin sets a compiler, then this should be the result that
* the compiler yields (`string`, `Buffer`, or something else).
* @this
* The current processor.
* Plugins can configure the processor by interacting with `this.Parser` or
* `this.Compiler`, or by accessing the data associated with the whole process
* (`this.data`).
* @param settings
* Configuration for plugin.
* Plugins typically receive one options object, but could receive other and
* more values.
* Users can also pass a boolean instead of settings: `true` (to turn
* a plugin on) or `false` (to turn a plugin off).
* When a plugin is turned off, it won’t be called.
*
* When creating your own plugins, please accept only a single object!
* It allows plugins to be reconfigured and it helps users to know that every
* plugin accepts one options object.
* @returns
* Plugins can return a `Transformer` to specify how the syntax tree is
* handled.
*/
export type Plugin<
PluginParameters extends any[] = any[],
Input = Node,
Output = Input
> = (
this: Input extends Node
? Output extends Node
? // This is a transform, so define `Input` as the current tree.
Processor<void, Input>
: // Compiler.
Processor<void, Input, Input, Output>
: Output extends Node
? // Parser.
Processor<Output, Output>
: // No clue.
Processor,
...settings: PluginParameters
) => // If both `Input` and `Output` are `Node`, expect an optional `Transformer`.
Input extends Node
? Output extends Node
? Transformer<Input, Output> | void
: void
: void
/**
* Presets provide a sharable way to configure processors with multiple plugins
* and/or settings.
*/
export interface Preset {
plugins?: PluggableList
settings?: Record<string, unknown>
}
/**
* A tuple of a plugin and its setting(s).
* The first item is a plugin (function) to use and other items are options.
* Plugins are deduped based on identity: passing a function in twice will
* cause it to run only once.
*
* @typeParam PluginParameters
* Plugin settings.
* @typeParam Input
* Value that is accepted by the plugin.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer expects.
* * If the plugin sets a parser, then this should be `string`.
* * If the plugin sets a compiler, then this should be the node type that
* the compiler expects.
* @typeParam Output
* Value that the plugin yields.
*
* * If the plugin returns a transformer, then this should be the node
* type that the transformer yields, and defaults to `Input`.
* * If the plugin sets a parser, then this should be the node type that
* the parser yields.
* * If the plugin sets a compiler, then this should be the result that
* the compiler yields (`string`, `Buffer`, or something else).
*/
export type PluginTuple<
PluginParameters extends any[] = any[],
Input = Node,
Output = Input
> = [Plugin<PluginParameters, Input, Output>, ...PluginParameters]
/**
* A union of the different ways to add plugins and settings.
*
* @typeParam PluginParameters
* Plugin settings.
*/
export type Pluggable<PluginParameters extends any[] = any[]> =
| PluginTuple<PluginParameters, any, any>
| Plugin<PluginParameters, any, any>
| Preset
/**
* A list of plugins and presets.
*/
export type PluggableList = Pluggable[]
/**
* @deprecated
* Please use `Plugin`.
*/
export type Attacher<
PluginParameters extends any[] = any[],
Input = Node,
Output = Input
> = Plugin<PluginParameters, Input, Output>
/**
* Transformers modify the syntax tree or metadata of a file.
* A transformer is a function that is called each time a file is passed
* through the transform phase.
* If an error occurs (either because it’s thrown, returned, rejected, or passed
* to `next`), the process stops.
*
* @typeParam Input
* Node type that the transformer expects.
* @typeParam Output
* Node type that the transformer yields.
* @param node
* Tree to be transformed.
* @param file
* File associated with node.
* @param next
* Callback that you must call when done.
* Note: this is given if you accept three parameters in your transformer.
* If you accept up to two parameters, it’s not given, and you can return
* a promise.
* @returns
* Any of the following:
*
* * `void` — If nothing is returned, the next transformer keeps using same
* tree.
* * `Error` — Can be returned to stop the process.
* * `Node` — Can be returned and results in further transformations and
* `stringify`s to be performed on the new tree.
* * `Promise` — If a promise is returned, the function is asynchronous, and
* must be resolved (optionally with a `Node`) or rejected (optionally with
* an `Error`).
*
* If you accept a `next` callback, nothing should be returned.
*/
export type Transformer<
Input extends Node = Node,
Output extends Node = Input
> = (
node: Input,
file: VFile,
next: TransformCallback<Output>
) => Promise<Output | undefined | void> | Output | Error | undefined | void
/**
* Callback you must call when a transformer is done.
*
* @typeParam Tree
* Node that the plugin yields.
* @param error
* Pass an error to stop the process.
* @param node
* Pass a tree to continue transformations (and `stringify`) on the new tree.
* @param file
* Pass a file to continue transformations (and `stringify`) on the new file.
* @returns
* Nothing.
*/
export type TransformCallback<Tree extends Node = Node> = (
error?: Error | null | undefined,
node?: Tree | undefined,
file?: VFile | undefined
) => void
/**
* Function handling the parsing of text to a syntax tree.
* Used in the parse phase in the process and called with a `string` and
* `VFile` representation of the document to parse.
*
* `Parser` can be a normal function, in which case it must return a `Node`:
* the syntax tree representation of the given file.
*
* `Parser` can also be a constructor function (a function with keys in its
* `prototype`), in which case it’s called with `new`.
* Instances must have a parse method that is called without arguments and
* must return a `Node`.
*
* @typeParam Tree
* The node that the parser yields (and `run` receives).
*/
export type Parser<Tree extends Node = Node> =
| ParserClass<Tree>
| ParserFunction<Tree>
/**
* A class to parse files.
*
* @typeParam Tree
* The node that the parser yields.
*/
export class ParserClass<Tree extends Node = Node> {
prototype: {
/**
* Parse a file.
*
* @returns
* Parsed tree.
*/
parse(): Tree
}
/**
* Constructor.
*
* @param document
* Document to parse.
* @param file
* File associated with `document`.
* @returns
* Instance.
*/
constructor(document: string, file: VFile)
}
/**
* Normal function to parse a file.
*
* @typeParam Tree
* The node that the parser yields.
* @param document
* Document to parse.
* @param file
* File associated with `document`.
* @returns
* Node representing the given file.
*/
export type ParserFunction<Tree extends Node = Node> = (
document: string,
file: VFile
) => Tree
/**
* Function handling the compilation of syntax tree to a text.
* Used in the stringify phase in the process and called with a `Node` and
* `VFile` representation of the document to stringify.
*
* `Compiler` can be a normal function, in which case it must return a
* `string`: the text representation of the given syntax tree.
*
* `Compiler` can also be a constructor function (a function with keys in its
* `prototype`), in which case it’s called with `new`.
* Instances must have a `compile` method that is called without arguments
* and must return a `string`.
*
* @typeParam Tree
* The node that the compiler receives.
* @typeParam Result
* The thing that the compiler yields.
*/
export type Compiler<Tree extends Node = Node, Result = unknown> =
| CompilerClass<Tree, Result>
| CompilerFunction<Tree, Result>
/**
* A class to compile trees.
*
* @typeParam Tree
* The node that the compiler receives.
* @typeParam Result
* The thing that the compiler yields.
*/
export class CompilerClass<Tree extends Node = Node, Result = unknown> {
prototype: {
/**
* Compile a tree.
*
* @returns
* New content: compiled text (`string` or `Buffer`, for `file.value`) or
* something else (for `file.result`).
*/
compile(): Result
}
/**
* Constructor.
*
* @param tree
* Tree to compile.
* @param file
* File associated with `tree`.
* @returns
* Instance.
*/
constructor(tree: Tree, file: VFile)
}
/**
* Normal function to compile a tree.
*
* @typeParam Tree
* The node that the compiler receives.
* @typeParam Result
* The thing that the compiler yields.
* @param tree
* Tree to compile.
* @param file
* File associated with `tree`.
* @returns
* New content: compiled text (`string` or `Buffer`, for `file.value`) or
* something else (for `file.result`).
*/
export type CompilerFunction<Tree extends Node = Node, Result = unknown> = (
tree: Tree,
file: VFile
) => Result
/**
* Callback called when a done running.
*
* @typeParam Tree
* The tree that the callback receives.
* @param error
* Error passed when unsuccessful.
* @param node
* Tree to transform.
* @param file
* File passed when successful.
* @returns
* Nothing.
*/
export type RunCallback<Tree extends Node = Node> = (
error?: Error | null | undefined,
node?: Tree | undefined,
file?: VFile | undefined
) => void
/**
* Callback called when a done processing.
*
* @typeParam File
* The file that the callback receives.
* @param error
* Error passed when unsuccessful.
* @param file
* File passed when successful.
* @returns
* Nothing.
*/
export type ProcessCallback<File extends VFile = VFile> = (
error?: Error | null | undefined,
file?: File | undefined
) => void
/**
* A frozen processor.
*/
export function unified(): Processor

1
node_modules/unified/index.js generated vendored Normal file
View file

@ -0,0 +1 @@
export {unified} from './lib/index.js'

19
node_modules/unified/lib/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,19 @@
export const unified: import('..').FrozenProcessor<void, void, void, void>
export type Node = import('unist').Node
export type VFileCompatible = import('vfile').VFileCompatible
export type VFileValue = import('vfile').VFileValue
export type Processor = import('..').Processor
export type Plugin = import('..').Plugin
export type Preset = import('..').Preset
export type Pluggable = import('..').Pluggable
export type PluggableList = import('..').PluggableList
export type Transformer = import('..').Transformer
export type Parser = import('..').Parser
export type Compiler = import('..').Compiler
export type RunCallback = import('..').RunCallback
export type ProcessCallback = import('..').ProcessCallback
export type Context = {
tree: Node
file: VFile
}
import {VFile} from 'vfile'

599
node_modules/unified/lib/index.js generated vendored Normal file
View file

@ -0,0 +1,599 @@
/**
* @typedef {import('unist').Node} Node
* @typedef {import('vfile').VFileCompatible} VFileCompatible
* @typedef {import('vfile').VFileValue} VFileValue
* @typedef {import('..').Processor} Processor
* @typedef {import('..').Plugin} Plugin
* @typedef {import('..').Preset} Preset
* @typedef {import('..').Pluggable} Pluggable
* @typedef {import('..').PluggableList} PluggableList
* @typedef {import('..').Transformer} Transformer
* @typedef {import('..').Parser} Parser
* @typedef {import('..').Compiler} Compiler
* @typedef {import('..').RunCallback} RunCallback
* @typedef {import('..').ProcessCallback} ProcessCallback
*
* @typedef Context
* @property {Node} tree
* @property {VFile} file
*/
import {bail} from 'bail'
import isBuffer from 'is-buffer'
import extend from 'extend'
import isPlainObj from 'is-plain-obj'
import {trough} from 'trough'
import {VFile} from 'vfile'
// Expose a frozen processor.
export const unified = base().freeze()
const own = {}.hasOwnProperty
// Function to create the first processor.
/**
* @returns {Processor}
*/
function base() {
const transformers = trough()
/** @type {Processor['attachers']} */
const attachers = []
/** @type {Record<string, unknown>} */
let namespace = {}
/** @type {boolean|undefined} */
let frozen
let freezeIndex = -1
// Data management.
// @ts-expect-error: overloads are handled.
processor.data = data
processor.Parser = undefined
processor.Compiler = undefined
// Lock.
processor.freeze = freeze
// Plugins.
processor.attachers = attachers
// @ts-expect-error: overloads are handled.
processor.use = use
// API.
processor.parse = parse
processor.stringify = stringify
// @ts-expect-error: overloads are handled.
processor.run = run
processor.runSync = runSync
// @ts-expect-error: overloads are handled.
processor.process = process
processor.processSync = processSync
// Expose.
return processor
// Create a new processor based on the processor in the current scope.
/** @type {Processor} */
function processor() {
const destination = base()
let index = -1
while (++index < attachers.length) {
destination.use(...attachers[index])
}
destination.data(extend(true, {}, namespace))
return destination
}
/**
* @param {string|Record<string, unknown>} [key]
* @param {unknown} [value]
* @returns {unknown}
*/
function data(key, value) {
if (typeof key === 'string') {
// Set `key`.
if (arguments.length === 2) {
assertUnfrozen('data', frozen)
namespace[key] = value
return processor
}
// Get `key`.
return (own.call(namespace, key) && namespace[key]) || null
}
// Set space.
if (key) {
assertUnfrozen('data', frozen)
namespace = key
return processor
}
// Get space.
return namespace
}
/** @type {Processor['freeze']} */
function freeze() {
if (frozen) {
return processor
}
while (++freezeIndex < attachers.length) {
const [attacher, ...options] = attachers[freezeIndex]
if (options[0] === false) {
continue
}
if (options[0] === true) {
options[0] = undefined
}
/** @type {Transformer|void} */
const transformer = attacher.call(processor, ...options)
if (typeof transformer === 'function') {
transformers.use(transformer)
}
}
frozen = true
freezeIndex = Number.POSITIVE_INFINITY
return processor
}
/**
* @param {Pluggable|null|undefined} [value]
* @param {...unknown} options
* @returns {Processor}
*/
function use(value, ...options) {
/** @type {Record<string, unknown>|undefined} */
let settings
assertUnfrozen('use', frozen)
if (value === null || value === undefined) {
// Empty.
} else if (typeof value === 'function') {
addPlugin(value, ...options)
} else if (typeof value === 'object') {
if (Array.isArray(value)) {
addList(value)
} else {
addPreset(value)
}
} else {
throw new TypeError('Expected usable value, not `' + value + '`')
}
if (settings) {
namespace.settings = Object.assign(namespace.settings || {}, settings)
}
return processor
/**
* @param {import('..').Pluggable<unknown[]>} value
* @returns {void}
*/
function add(value) {
if (typeof value === 'function') {
addPlugin(value)
} else if (typeof value === 'object') {
if (Array.isArray(value)) {
const [plugin, ...options] = value
addPlugin(plugin, ...options)
} else {
addPreset(value)
}
} else {
throw new TypeError('Expected usable value, not `' + value + '`')
}
}
/**
* @param {Preset} result
* @returns {void}
*/
function addPreset(result) {
addList(result.plugins)
if (result.settings) {
settings = Object.assign(settings || {}, result.settings)
}
}
/**
* @param {PluggableList|null|undefined} [plugins]
* @returns {void}
*/
function addList(plugins) {
let index = -1
if (plugins === null || plugins === undefined) {
// Empty.
} else if (Array.isArray(plugins)) {
while (++index < plugins.length) {
const thing = plugins[index]
add(thing)
}
} else {
throw new TypeError('Expected a list of plugins, not `' + plugins + '`')
}
}
/**
* @param {Plugin} plugin
* @param {...unknown} [value]
* @returns {void}
*/
function addPlugin(plugin, value) {
let index = -1
/** @type {Processor['attachers'][number]|undefined} */
let entry
while (++index < attachers.length) {
if (attachers[index][0] === plugin) {
entry = attachers[index]
break
}
}
if (entry) {
if (isPlainObj(entry[1]) && isPlainObj(value)) {
value = extend(true, entry[1], value)
}
entry[1] = value
} else {
// @ts-expect-error: fine.
attachers.push([...arguments])
}
}
}
/** @type {Processor['parse']} */
function parse(doc) {
processor.freeze()
const file = vfile(doc)
const Parser = processor.Parser
assertParser('parse', Parser)
if (newable(Parser, 'parse')) {
// @ts-expect-error: `newable` checks this.
return new Parser(String(file), file).parse()
}
// @ts-expect-error: `newable` checks this.
return Parser(String(file), file) // eslint-disable-line new-cap
}
/** @type {Processor['stringify']} */
function stringify(node, doc) {
processor.freeze()
const file = vfile(doc)
const Compiler = processor.Compiler
assertCompiler('stringify', Compiler)
assertNode(node)
if (newable(Compiler, 'compile')) {
// @ts-expect-error: `newable` checks this.
return new Compiler(node, file).compile()
}
// @ts-expect-error: `newable` checks this.
return Compiler(node, file) // eslint-disable-line new-cap
}
/**
* @param {Node} node
* @param {VFileCompatible|RunCallback} [doc]
* @param {RunCallback} [callback]
* @returns {Promise<Node>|void}
*/
function run(node, doc, callback) {
assertNode(node)
processor.freeze()
if (!callback && typeof doc === 'function') {
callback = doc
doc = undefined
}
if (!callback) {
return new Promise(executor)
}
executor(null, callback)
/**
* @param {null|((node: Node) => void)} resolve
* @param {(error: Error) => void} reject
* @returns {void}
*/
function executor(resolve, reject) {
// @ts-expect-error: `doc` can’t be a callback anymore, we checked.
transformers.run(node, vfile(doc), done)
/**
* @param {Error|null} error
* @param {Node} tree
* @param {VFile} file
* @returns {void}
*/
function done(error, tree, file) {
tree = tree || node
if (error) {
reject(error)
} else if (resolve) {
resolve(tree)
} else {
// @ts-expect-error: `callback` is defined if `resolve` is not.
callback(null, tree, file)
}
}
}
}
/** @type {Processor['runSync']} */
function runSync(node, file) {
/** @type {Node|undefined} */
let result
/** @type {boolean|undefined} */
let complete
processor.run(node, file, done)
assertDone('runSync', 'run', complete)
// @ts-expect-error: we either bailed on an error or have a tree.
return result
/**
* @param {Error|null} [error]
* @param {Node} [tree]
* @returns {void}
*/
function done(error, tree) {
bail(error)
result = tree
complete = true
}
}
/**
* @param {VFileCompatible} doc
* @param {ProcessCallback} [callback]
* @returns {Promise<VFile>|undefined}
*/
function process(doc, callback) {
processor.freeze()
assertParser('process', processor.Parser)
assertCompiler('process', processor.Compiler)
if (!callback) {
return new Promise(executor)
}
executor(null, callback)
/**
* @param {null|((file: VFile) => void)} resolve
* @param {(error?: Error|null|undefined) => void} reject
* @returns {void}
*/
function executor(resolve, reject) {
const file = vfile(doc)
processor.run(processor.parse(file), file, (error, tree, file) => {
if (error || !tree || !file) {
done(error)
} else {
/** @type {unknown} */
const result = processor.stringify(tree, file)
if (result === undefined || result === null) {
// Empty.
} else if (looksLikeAVFileValue(result)) {
file.value = result
} else {
file.result = result
}
done(error, file)
}
})
/**
* @param {Error|null|undefined} [error]
* @param {VFile|undefined} [file]
* @returns {void}
*/
function done(error, file) {
if (error || !file) {
reject(error)
} else if (resolve) {
resolve(file)
} else {
// @ts-expect-error: `callback` is defined if `resolve` is not.
callback(null, file)
}
}
}
}
/** @type {Processor['processSync']} */
function processSync(doc) {
/** @type {boolean|undefined} */
let complete
processor.freeze()
assertParser('processSync', processor.Parser)
assertCompiler('processSync', processor.Compiler)
const file = vfile(doc)
processor.process(file, done)
assertDone('processSync', 'process', complete)
return file
/**
* @param {Error|null|undefined} [error]
* @returns {void}
*/
function done(error) {
complete = true
bail(error)
}
}
}
/**
* Check if `value` is a constructor.
*
* @param {unknown} value
* @param {string} name
* @returns {boolean}
*/
function newable(value, name) {
return (
typeof value === 'function' &&
// Prototypes do exist.
// type-coverage:ignore-next-line
value.prototype &&
// A function with keys in its prototype is probably a constructor.
// Classes’ prototype methods are not enumerable, so we check if some value
// exists in the prototype.
// type-coverage:ignore-next-line
(keys(value.prototype) || name in value.prototype)
)
}
/**
* Check if `value` is an object with keys.
*
* @param {Record<string, unknown>} value
* @returns {boolean}
*/
function keys(value) {
/** @type {string} */
let key
for (key in value) {
if (own.call(value, key)) {
return true
}
}
return false
}
/**
* Assert a parser is available.
*
* @param {string} name
* @param {unknown} value
* @returns {asserts value is Parser}
*/
function assertParser(name, value) {
if (typeof value !== 'function') {
throw new TypeError('Cannot `' + name + '` without `Parser`')
}
}
/**
* Assert a compiler is available.
*
* @param {string} name
* @param {unknown} value
* @returns {asserts value is Compiler}
*/
function assertCompiler(name, value) {
if (typeof value !== 'function') {
throw new TypeError('Cannot `' + name + '` without `Compiler`')
}
}
/**
* Assert the processor is not frozen.
*
* @param {string} name
* @param {unknown} frozen
* @returns {asserts frozen is false}
*/
function assertUnfrozen(name, frozen) {
if (frozen) {
throw new Error(
'Cannot call `' +
name +
'` on a frozen processor.\nCreate a new processor first, by calling it: use `processor()` instead of `processor`.'
)
}
}
/**
* Assert `node` is a unist node.
*
* @param {unknown} node
* @returns {asserts node is Node}
*/
function assertNode(node) {
// `isPlainObj` unfortunately uses `any` instead of `unknown`.
// type-coverage:ignore-next-line
if (!isPlainObj(node) || typeof node.type !== 'string') {
throw new TypeError('Expected node, got `' + node + '`')
// Fine.
}
}
/**
* Assert that `complete` is `true`.
*
* @param {string} name
* @param {string} asyncName
* @param {unknown} complete
* @returns {asserts complete is true}
*/
function assertDone(name, asyncName, complete) {
if (!complete) {
throw new Error(
'`' + name + '` finished async. Use `' + asyncName + '` instead'
)
}
}
/**
* @param {VFileCompatible} [value]
* @returns {VFile}
*/
function vfile(value) {
return looksLikeAVFile(value) ? value : new VFile(value)
}
/**
* @param {VFileCompatible} [value]
* @returns {value is VFile}
*/
function looksLikeAVFile(value) {
return Boolean(
value &&
typeof value === 'object' &&
'message' in value &&
'messages' in value
)
}
/**
* @param {unknown} [value]
* @returns {value is VFileValue}
*/
function looksLikeAVFileValue(value) {
return typeof value === 'string' || isBuffer(value)
}

21
node_modules/unified/license generated vendored Normal file
View file

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

107
node_modules/unified/package.json generated vendored Normal file
View file

@ -0,0 +1,107 @@
{
"name": "unified",
"version": "10.1.2",
"description": "Interface for parsing, inspecting, transforming, and serializing content through syntax trees",
"license": "MIT",
"keywords": [
"unified",
"process",
"parse",
"transform",
"compile",
"stringify",
"serialize",
"ast",
"cst",
"syntax",
"tree",
"content",
"rehype",
"retext",
"remark"
],
"homepage": "https://unifiedjs.com",
"repository": "unifiedjs/unified",
"bugs": "https://github.com/unifiedjs/unified/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)",
"Junyoung Choi <fluke8259@gmail.com>",
"Hernan Rajchert <hrajchert@gmail.com>",
"Christian Murphy <christian.murphy.42@gmail.com>",
"Vse Mozhet Byt <vsemozhetbyt@gmail.com>",
"Richard Littauer <richard.littauer@gmail.com>"
],
"sideEffects": false,
"type": "module",
"main": "index.js",
"types": "index.d.ts",
"files": [
"lib/",
"index.d.ts",
"index.js"
],
"dependencies": {
"@types/unist": "^2.0.0",
"bail": "^2.0.0",
"extend": "^3.0.0",
"is-buffer": "^2.0.0",
"is-plain-obj": "^4.0.0",
"trough": "^2.0.0",
"vfile": "^5.0.0"
},
"devDependencies": {
"@types/extend": "^3.0.0",
"@types/tape": "^4.0.0",
"c8": "^7.0.0",
"prettier": "^2.0.0",
"remark-cli": "^10.0.0",
"remark-preset-wooorm": "^9.0.0",
"rimraf": "^3.0.0",
"tape": "^5.0.0",
"tsd": "^0.19.0",
"type-coverage": "^2.0.0",
"typescript": "^4.0.0",
"xo": "^0.48.0"
},
"scripts": {
"build": "rimraf \"test/**/*.d.ts\" && tsc && tsd && type-coverage",
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
"test-api": "node --unhandled-rejections=strict --conditions development test/index.js",
"test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --unhandled-rejections=strict --conditions development test/index.js",
"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": {
"@typescript-eslint/ban-types": "off",
"promise/param-names": "off"
},
"ignores": [
"types/"
]
},
"remarkConfig": {
"plugins": [
"preset-wooorm"
]
},
"typeCoverage": {
"atLeast": 100,
"detail": true,
"strict": true,
"ignoreCatch": true
}
}

1450
node_modules/unified/readme.md generated vendored Normal file
View file

File diff suppressed because it is too large Load diff