From 76dd6cb56c42b84308087d705262661ce0aaa938 Mon Sep 17 00:00:00 2001 From: "Xunnamius (Romulus)" Date: Tue, 28 Nov 2023 06:17:26 -0800 Subject: [PATCH] chore(packages): regenerate docs --- packages/mdast-util-hidden/docs/README.md | 34 +++++++++---------- .../docs/interfaces/Hidden.md | 18 +++++----- .../mdast-util-tight-comments/docs/README.md | 2 +- .../remark-capitalize-headings/docs/README.md | 18 +++++----- packages/remark-ignore/docs/modules/end.md | 12 +++---- packages/remark-ignore/docs/modules/index.md | 10 +++--- packages/remark-ignore/docs/modules/start.md | 12 +++---- .../docs/README.md | 16 ++++----- .../docs/README.md | 16 ++++----- .../docs/README.md | 24 ++++++------- .../docs/README.md | 10 +++--- .../docs/README.md | 14 ++++---- .../remark-renumber-references/docs/README.md | 14 ++++---- .../remark-sort-definitions/docs/README.md | 14 ++++---- packages/remark-tight-comments/docs/README.md | 10 +++--- 15 files changed, 113 insertions(+), 111 deletions(-) diff --git a/packages/mdast-util-hidden/docs/README.md b/packages/mdast-util-hidden/docs/README.md index c97efc4..f36a911 100644 --- a/packages/mdast-util-hidden/docs/README.md +++ b/packages/mdast-util-hidden/docs/README.md @@ -28,7 +28,7 @@ Returns a new `Hidden` node ready to be inserted into a mdast tree. | Name | Type | | :------ | :------ | -| `children` | `Content`[] | +| `children` | `RootContent`[] | #### Returns @@ -36,13 +36,13 @@ Returns a new `Hidden` node ready to be inserted into a mdast tree. #### Defined in -[packages/mdast-util-hidden/src/index.ts:23](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L23) +[packages/mdast-util-hidden/src/index.ts:30](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L30) ___ ### hide -▸ **hide**<`Nodes`\>(`«destructured»`): `void` +▸ **hide**\<`Nodes`\>(`«destructured»`): `void` Inserts a `Hidden` node as a child of `parent` at `index`. Any `nodes` passed in will become the hidden children of this new node. @@ -51,7 +51,7 @@ in will become the hidden children of this new node. | Name | Type | | :------ | :------ | -| `Nodes` | extends `Content`[] | +| `Nodes` | extends `RootContent`[] | #### Parameters @@ -60,8 +60,8 @@ in will become the hidden children of this new node. | `«destructured»` | `Object` | - | | › `index` | `number` | - | | › `nodes` | `Nodes` | - | -| › `parent` | `Parent`<`Node`<`Data`\>, `Data`\> | - | -| › `replaceChildAtIndex?` | `boolean` | If `replaceChildAtIndex` is `true`, the child node of `parent` at `index` will be replaced by the new `Hidden` node. On the other hand, if `replaceChildAtIndex` is `false`, this function will not remove any nodes from `parent`. In this case, if you do not manually remove the node at `index`, **you must skip two nodes ahead instead of just one when using a visitor or risk an infinite loop!** **`Default`** true **`Example`** ```typescript visit(tree, 'heading', (node, index, parent) => { if (index !== null && parent !== null) { hide({ nodes: [node], index, parent, replaceChildAtIndex: false }); return [SKIP, index + 2]; // <- +2 here is IMPORTANT } }); ``` | +| › `parent` | `Parent` | - | +| › `replaceChildAtIndex?` | `boolean` | If `replaceChildAtIndex` is `true`, the child node of `parent` at `index` will be replaced by the new `Hidden` node. On the other hand, if `replaceChildAtIndex` is `false`, this function will not remove any nodes from `parent`. In this case, if you do not manually remove the node at `index`, **you must skip two nodes ahead instead of just one when using a visitor or risk an infinite loop!** **`Default`** ```ts true ``` **`Example`** ```typescript visit(tree, 'heading', (node, index, parent) => { if (index !== undefined && parent !== undefined) { hide({ nodes: [node], index, parent, replaceChildAtIndex: false }); return [SKIP, index + 2]; // <- +2 here is IMPORTANT } }); ``` | #### Returns @@ -69,7 +69,7 @@ in will become the hidden children of this new node. #### Defined in -[packages/mdast-util-hidden/src/index.ts:42](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L42) +[packages/mdast-util-hidden/src/index.ts:49](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L49) ___ @@ -84,7 +84,7 @@ instance. | Name | Type | | :------ | :------ | -| `node` | `Node`<`Data`\> | +| `node` | `Node` | #### Returns @@ -92,13 +92,13 @@ node is Hidden #### Defined in -[packages/mdast-util-hidden/src/index.ts:34](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L34) +[packages/mdast-util-hidden/src/index.ts:41](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L41) ___ ### reveal -▸ **reveal**<`Nodes`\>(`«destructured»`): `void` +▸ **reveal**\<`Nodes`\>(`«destructured»`): `void` Replaces the child node of `parent` at `index` with the hidden children of one or more `Hidden` `nodes`. @@ -116,7 +116,7 @@ one or more `Hidden` `nodes`. | `«destructured»` | `Object` | | › `index` | `number` | | › `nodes` | `Nodes` | -| › `parent` | `Parent`<`Node`<`Data`\>, `Data`\> | +| › `parent` | `Parent` | #### Returns @@ -124,13 +124,13 @@ one or more `Hidden` `nodes`. #### Defined in -[packages/mdast-util-hidden/src/index.ts:85](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L85) +[packages/mdast-util-hidden/src/index.ts:92](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L92) ___ ### visitAndReveal -▸ **visitAndReveal**<`Tree`\>(`«destructured»`): `void` +▸ **visitAndReveal**\<`Tree`\>(`«destructured»`): `void` Walks `tree` using unist-util-visit to search for any `Hidden` nodes. Upon encountering a `Hidden` node, `visitor` is called if provided. @@ -147,16 +147,16 @@ instead. | Name | Type | | :------ | :------ | -| `Tree` | extends `Node`<`Data`, `Tree`\> | +| `Tree` | extends `Node` | #### Parameters | Name | Type | Description | | :------ | :------ | :------ | | `«destructured»` | `Object` | - | -| › `reverse?` | `boolean` | **`See`** https://github.com/syntax-tree/unist-util-visit#visittree-test-visitor-reverse **`Default`** false | +| › `reverse?` | `boolean` | **`See`** https://github.com/syntax-tree/unist-util-visit#visittree-test-visitor-reverse **`Default`** ```ts false ``` | | › `tree` | `Tree` | **`See`** https://github.com/syntax-tree/unist-util-visit#visittree-test-visitor-reverse | -| › `visitor?` | `Visitor`<`Node`<`Data`\>, `Parent`<`Node`<`Data`\>, `Data`\>\> | If `visitor` is provided but returns `false`, `reveal` is not called and the hidden is not revealed. Otherwise, `reveal` will always be called. If `visitor` is provided and returns a defined value other than `false`, that value will be passed through to unist-util-visit. If `visitor` is not provided, or it returns `undefined`, `[SKIP, index]` will be passed through instead. | +| › `visitor?` | `Visitor` | If `visitor` is provided but returns `false`, `reveal` is not called and the hidden is not revealed. Otherwise, `reveal` will always be called. If `visitor` is provided and returns a defined value other than `false`, that value will be passed through to unist-util-visit. If `visitor` is not provided, or it returns `undefined`, `[SKIP, index]` will be passed through instead. | #### Returns @@ -164,4 +164,4 @@ instead. #### Defined in -[packages/mdast-util-hidden/src/index.ts:113](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L113) +[packages/mdast-util-hidden/src/index.ts:125](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L125) diff --git a/packages/mdast-util-hidden/docs/interfaces/Hidden.md b/packages/mdast-util-hidden/docs/interfaces/Hidden.md index 71edaae..f4c032d 100644 --- a/packages/mdast-util-hidden/docs/interfaces/Hidden.md +++ b/packages/mdast-util-hidden/docs/interfaces/Hidden.md @@ -29,7 +29,7 @@ cannot be derived from markdown directly. • `Optional` **data**: `Data` -Information from the ecosystem. +Info from the ecosystem. #### Inherited from @@ -37,17 +37,17 @@ Node.data #### Defined in -node_modules/@types/unist/index.d.ts:27 +node_modules/@types/unist/index.d.ts:95 ___ ### hiddenChildren -• **hiddenChildren**: `Content`[] +• **hiddenChildren**: `RootContent`[] #### Defined in -[packages/mdast-util-hidden/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L17) +[packages/mdast-util-hidden/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L17) ___ @@ -55,8 +55,10 @@ ___ • `Optional` **position**: `Position` -Location of a node in a source document. -Must not be present if a node is generated. +Position of a node in a source document. + +Nodes that are generated (not in the original source document) must not +have a position. #### Inherited from @@ -64,7 +66,7 @@ Node.position #### Defined in -node_modules/@types/unist/index.d.ts:33 +node_modules/@types/unist/index.d.ts:103 ___ @@ -78,4 +80,4 @@ Node.type #### Defined in -[packages/mdast-util-hidden/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-hidden/src/index.ts#L16) +[packages/mdast-util-hidden/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-hidden/src/index.ts#L16) diff --git a/packages/mdast-util-tight-comments/docs/README.md b/packages/mdast-util-tight-comments/docs/README.md index a09a970..1eaef69 100644 --- a/packages/mdast-util-tight-comments/docs/README.md +++ b/packages/mdast-util-tight-comments/docs/README.md @@ -23,4 +23,4 @@ HTML comments and select other mdast nodes under certain conditions. #### Defined in -[index.ts:7](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/mdast-util-tight-comments/src/index.ts#L7) +[index.ts:7](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/mdast-util-tight-comments/src/index.ts#L7) diff --git a/packages/remark-capitalize-headings/docs/README.md b/packages/remark-capitalize-headings/docs/README.md index 463943f..3f0b626 100644 --- a/packages/remark-capitalize-headings/docs/README.md +++ b/packages/remark-capitalize-headings/docs/README.md @@ -24,19 +24,19 @@ Options type for the remark-remove-url-trailing-slash plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `excludeHeadingLevel?` | { [level in "h1" \| "h2" \| "h3" \| "h4" \| "h5" \| "h6"]?: boolean } | Headings of the specified `level` in `{ [level]: true }` will be excluded from capitalization entirely, where `h1` corresponds to `

…

`/`# …`, `h2` to `

…

`/`## …`, etc. > Excludes with `false` values are treated as if they were commented out. **`Default`** | -| `excludeSectionRegExp?` | (`string` \| `RegExp`)[] | Entire sections with a stringified heading matching at least one of the given regular expression strings will be excluded from capitalization entirely. **`Default`** [] | -| `replaceHeadingRegExp?` | { `[regExp: string]`: `string`; } | This option lets you manipulate non-excluded headers in their stringified form _after they've been transformed by title_ by leveraging mdast position data. This extra context is useful for tasks like capitalizing a word only if it appears at the end of a heading, or as part of a phrase, or to prevent a word from being capitalized. This option also supports using matching groups in during replacement. **`Default`** | +| `excludeHeadingLevel?` | \{ [level in "h1" \| "h2" \| "h3" \| "h4" \| "h5" \| "h6"]?: boolean } | Headings of the specified `level` in `{ [level]: true }` will be excluded from capitalization entirely, where `h1` corresponds to `

…

`/`# …`, `h2` to `

…

`/`## …`, etc. > Excludes with `false` values are treated as if they were commented out. **`Default`** ```ts {} ``` | +| `excludeSectionRegExp?` | (`string` \| `RegExp`)[] | Entire sections with a stringified heading matching at least one of the given regular expression strings will be excluded from capitalization entirely. **`Default`** ```ts [] ``` | +| `replaceHeadingRegExp?` | \{ `[regExp: string]`: `string`; } | This option lets you manipulate non-excluded headers in their stringified form _after they've been transformed by title_ by leveraging mdast position data. This extra context is useful for tasks like capitalizing a word only if it appears at the end of a heading, or as part of a phrase, or to prevent a word from being capitalized. This option also supports using matching groups in during replacement. **`Default`** ```ts { "(?<=\\s)a(?=\\p{P})": "A" } ``` | #### Defined in -[packages/remark-capitalize-headings/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-capitalize-headings/src/index.ts#L12) +[packages/remark-capitalize-headings/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-capitalize-headings/src/index.ts#L12) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all heading nodes capitalized using Vercel's `title` package. @@ -45,13 +45,13 @@ with all heading nodes capitalized using Vercel's `title` package. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | [options: Options] \| `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [options: Options] \| `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-ignore/docs/modules/end.md b/packages/remark-ignore/docs/modules/end.md index 3ac2941..2c2d5a7 100644 --- a/packages/remark-ignore/docs/modules/end.md +++ b/packages/remark-ignore/docs/modules/end.md @@ -13,7 +13,7 @@ ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all hidden child nodes revealed. @@ -22,16 +22,16 @@ with all hidden child nodes revealed. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 ___ @@ -54,4 +54,4 @@ node with all hidden child nodes revealed. #### Defined in -[packages/remark-ignore/src/end.ts:18](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-ignore/src/end.ts#L18) +[packages/remark-ignore/src/end.ts:18](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-ignore/src/end.ts#L18) diff --git a/packages/remark-ignore/docs/modules/index.md b/packages/remark-ignore/docs/modules/index.md index 4f16675..bf27efb 100644 --- a/packages/remark-ignore/docs/modules/index.md +++ b/packages/remark-ignore/docs/modules/index.md @@ -29,7 +29,7 @@ Renames and re-exports [default](start.md#default) ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all child nodes following an ignore command having been hidden. After @@ -43,13 +43,13 @@ from other plugins until said nodes are revealed. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-ignore/docs/modules/start.md b/packages/remark-ignore/docs/modules/start.md index 96b6a58..aaf06f7 100644 --- a/packages/remark-ignore/docs/modules/start.md +++ b/packages/remark-ignore/docs/modules/start.md @@ -13,7 +13,7 @@ ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all child nodes following an ignore command having been hidden. @@ -25,16 +25,16 @@ from other plugins until said nodes are revealed. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 ___ @@ -57,4 +57,4 @@ node with all child nodes following an ignore command having been hidden. #### Defined in -[packages/remark-ignore/src/start.ts:23](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-ignore/src/start.ts#L23) +[packages/remark-ignore/src/start.ts:23](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-ignore/src/start.ts#L23) diff --git a/packages/remark-lint-fenced-code-flag-case/docs/README.md b/packages/remark-lint-fenced-code-flag-case/docs/README.md index 40fa212..dd7f8f1 100644 --- a/packages/remark-lint-fenced-code-flag-case/docs/README.md +++ b/packages/remark-lint-fenced-code-flag-case/docs/README.md @@ -28,11 +28,11 @@ Options type for the remark-lint-fenced-code-flag-case plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `case?` | typeof [`optionsCases`](README.md#optionscases)[`number`] | All code fence flags must be of the specified case. Code fences without flags are ignored. **`Default`** "lower" | +| `case?` | typeof [`optionsCases`](README.md#optionscases)[`number`] | All code fence flags must be of the specified case. Code fences without flags are ignored. **`Default`** ```ts "lower" ``` | #### Defined in -[packages/remark-lint-fenced-code-flag-case/src/index.ts:17](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-fenced-code-flag-case/src/index.ts#L17) +[packages/remark-lint-fenced-code-flag-case/src/index.ts:18](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-fenced-code-flag-case/src/index.ts#L18) ## Variables @@ -44,13 +44,13 @@ Valid values for the Options.case property. #### Defined in -[packages/remark-lint-fenced-code-flag-case/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-fenced-code-flag-case/src/index.ts#L12) +[packages/remark-lint-fenced-code-flag-case/src/index.ts:13](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-fenced-code-flag-case/src/index.ts#L13) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> A remark-lint rule that takes a Root node as input and attaches any error messages to the resulting virtual file pertaining to fenced code flag case. @@ -59,13 +59,13 @@ messages to the resulting virtual file pertaining to fenced code flag case. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Node`<`Data`\>, `void`, `void`\> | -| `...settings` | `void`[] \| [`unknown`] \| [`boolean` \| `Label` \| `Severity`, `unknown`] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [[`Options`](README.md#options)] \| [] | #### Returns -`void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +`undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-lint-heading-word-length/docs/README.md b/packages/remark-lint-heading-word-length/docs/README.md index 996f227..91a9fd1 100644 --- a/packages/remark-lint-heading-word-length/docs/README.md +++ b/packages/remark-lint-heading-word-length/docs/README.md @@ -24,18 +24,18 @@ Options type for the remark-lint-heading-word-length plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `maximumWords?` | ``false`` \| `number` | The maximum number of words allowed in a heading. Set to `false` (or `Infinity`) to prevent maximum word length checks. **`Default`** 10 | -| `minimumWords?` | ``false`` \| `number` | The minimum number of words required in a heading. Set to `false` to prevent minimum word length checks. **`Default`** 1 | +| `maximumWords?` | ``false`` \| `number` | The maximum number of words allowed in a heading. Set to `false` (or `Infinity`) to prevent maximum word length checks. **`Default`** ```ts 10 ``` | +| `minimumWords?` | ``false`` \| `number` | The minimum number of words required in a heading. Set to `false` to prevent minimum word length checks. **`Default`** ```ts 1 ``` | #### Defined in -[packages/remark-lint-heading-word-length/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-heading-word-length/src/index.ts#L14) +[packages/remark-lint-heading-word-length/src/index.ts:15](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-heading-word-length/src/index.ts#L15) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> A remark-lint rule that takes a Root node as input and attaches any error messages to the resulting virtual file pertaining to fenced code flag case. @@ -44,13 +44,13 @@ messages to the resulting virtual file pertaining to fenced code flag case. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Node`<`Data`\>, `void`, `void`\> | -| `...settings` | `void`[] \| [`unknown`] \| [`boolean` \| `Label` \| `Severity`, `unknown`] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [[`Options`](README.md#options)] \| [] | #### Returns -`void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +`undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-lint-list-item-style/docs/README.md b/packages/remark-lint-list-item-style/docs/README.md index 0e6f80a..826b591 100644 --- a/packages/remark-lint-list-item-style/docs/README.md +++ b/packages/remark-lint-list-item-style/docs/README.md @@ -29,14 +29,14 @@ Options type for the remark-lint-list-item-style plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `checkFirstWord?` | typeof [`optionsCheckFirstWord`](README.md#optionscheckfirstword)[`number`] | Checks that the first word of each stringified list item paragraph begins with a non-lowercase character (`"capitalize"`) or a non-uppercase character (`"lowercase"`). List items beginning with a link, image, or inline code block are ignored. **`Default`** "capitalize" | -| `checkListSpread?` | typeof [`optionsCheckListSpread`](README.md#optionschecklistspread)[`number`] | Determines how `checkPunctuation` is applied to list items with spread children. Has no effect when `checkPunctuation` is `false`. **`Default`** "each" | -| `checkPunctuation?` | ``false`` \| (`string` \| `RegExp`)[] | Checks that the final character of each stringified list item matches at least one of the given values. To match all unicode punctuation characters, you could provide `["\p{P}"]` instead of the default, but this will match characters like `)` and `]`. Alternatively, to prevent punctuation, you could provide `["\P{P}"]`. Lines that consist solely of an image are ignored. **`Default`** ["(\\.\|\\?\|;\|,\|!)"] | -| `ignoredFirstWords?` | (`string` \| `RegExp`)[] | Words that would normally be checked with respect to the `checkFirstWord` option will be ignored if they match at least one of the given values. Use this option to prevent false positives (e.g. "iOS", "eBay"). **`Default`** [] | +| `checkFirstWord?` | typeof [`optionsCheckFirstWord`](README.md#optionscheckfirstword)[`number`] | Checks that the first word of each stringified list item paragraph begins with a non-lowercase character (`"capitalize"`) or a non-uppercase character (`"lowercase"`). List items beginning with a link, image, or inline code block are ignored. **`Default`** ```ts "capitalize" ``` | +| `checkListSpread?` | typeof [`optionsCheckListSpread`](README.md#optionschecklistspread)[`number`] | Determines how `checkPunctuation` is applied to list items with spread children. Has no effect when `checkPunctuation` is `false`. **`Default`** ```ts "each" ``` | +| `checkPunctuation?` | ``false`` \| (`string` \| `RegExp`)[] | Checks that the final character of each stringified list item matches at least one of the given values. To match all unicode punctuation characters, you could provide `["\p{P}"]` instead of the default, but this will match characters like `)` and `]`. Alternatively, to prevent punctuation, you could provide `["\P{P}"]`. Lines that consist solely of an image are ignored. **`Default`** ```ts ["(\\.\|\\?\|;\|,\|!)"] ``` | +| `ignoredFirstWords?` | (`string` \| `RegExp`)[] | Words that would normally be checked with respect to the `checkFirstWord` option will be ignored if they match at least one of the given values. Use this option to prevent false positives (e.g. "iOS", "eBay"). **`Default`** ```ts [] ``` | #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:29](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-list-item-style/src/index.ts#L29) +[packages/remark-lint-list-item-style/src/index.ts:30](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-list-item-style/src/index.ts#L30) ## Variables @@ -48,7 +48,7 @@ Valid values for the Options.checkFirstWord property. #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:14](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-list-item-style/src/index.ts#L14) +[packages/remark-lint-list-item-style/src/index.ts:15](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-list-item-style/src/index.ts#L15) ___ @@ -60,13 +60,13 @@ Valid values for the Options.checkListSpread property. #### Defined in -[packages/remark-lint-list-item-style/src/index.ts:19](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-lint-list-item-style/src/index.ts#L19) +[packages/remark-lint-list-item-style/src/index.ts:20](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-lint-list-item-style/src/index.ts#L20) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> A remark-lint rule that takes a Root node as input and attaches any error messages to the resulting virtual file pertaining to list item style. @@ -75,13 +75,13 @@ messages to the resulting virtual file pertaining to list item style. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Node`<`Data`\>, `void`, `void`\> | -| `...settings` | `void`[] \| [`unknown`] \| [`boolean` \| `Label` \| `Severity`, `unknown`] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [[`Options`](README.md#options)] \| [] | #### Returns -`void` \| `Transformer`<`Node`<`Data`\>, `Node`<`Data`\>\> +`undefined` \| `void` \| `Transformer`\<`Node`, `Node`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-remove-unused-definitions/docs/README.md b/packages/remark-remove-unused-definitions/docs/README.md index cc1dbb9..6cd45c6 100644 --- a/packages/remark-remove-unused-definitions/docs/README.md +++ b/packages/remark-remove-unused-definitions/docs/README.md @@ -12,7 +12,7 @@ remark-remove-unused-definitions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all unused definition nodes deleted. @@ -21,13 +21,13 @@ with all unused definition nodes deleted. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-remove-url-trailing-slash/docs/README.md b/packages/remark-remove-url-trailing-slash/docs/README.md index d99420c..5f0324d 100644 --- a/packages/remark-remove-url-trailing-slash/docs/README.md +++ b/packages/remark-remove-url-trailing-slash/docs/README.md @@ -24,17 +24,17 @@ Options type for the remark-remove-url-trailing-slash plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `onlyConsiderHostUrls?` | `boolean` | If this option is `false`, trailing slashes will be removed from all URL paths, including single-character `/` paths (i.e. "empty" paths). If this option is `true`, trailing slashes will only be removed from non-relative URLs with empty paths, e.g. `https://example.com/ => https://example.com`. **`Default`** false | +| `onlyConsiderHostUrls?` | `boolean` | If this option is `false`, trailing slashes will be removed from all URL paths, including single-character `/` paths (i.e. "empty" paths). If this option is `true`, trailing slashes will only be removed from non-relative URLs with empty paths, e.g. `https://example.com/ => https://example.com`. **`Default`** ```ts false ``` | #### Defined in -[packages/remark-remove-url-trailing-slash/src/index.ts:11](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-remove-url-trailing-slash/src/index.ts#L11) +[packages/remark-remove-url-trailing-slash/src/index.ts:11](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-remove-url-trailing-slash/src/index.ts#L11) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all Link, Image, and Definition node `url` paths stripped of @@ -44,13 +44,13 @@ trialing slashes. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | [options: Options] \| `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [options: Options] \| `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-renumber-references/docs/README.md b/packages/remark-renumber-references/docs/README.md index 29442d0..eabf8f0 100644 --- a/packages/remark-renumber-references/docs/README.md +++ b/packages/remark-renumber-references/docs/README.md @@ -24,17 +24,17 @@ Options type for the remark-renumber-references plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `preserveAlphanumericDefinitions?` | `boolean` | If `true`, alphanumeric definition ids (i.e. any id that cannot be parsed into an integer) will be spared during the renumbering. If `false`, _all_ definition ids will be deleted and recreated starting from `[1]`. **`Default`** true | +| `preserveAlphanumericDefinitions?` | `boolean` | If `true`, alphanumeric definition ids (i.e. any id that cannot be parsed into an integer) will be spared during the renumbering. If `false`, _all_ definition ids will be deleted and recreated starting from `[1]`. **`Default`** ```ts true ``` | #### Defined in -[packages/remark-renumber-references/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-renumber-references/src/index.ts#L16) +[packages/remark-renumber-references/src/index.ts:16](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-renumber-references/src/index.ts#L16) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all reference-style link nodes and their definition nodes renumbered in @@ -46,13 +46,13 @@ Links are assigned a numeric reference id as they are encountered. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | [options: Options] \| `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [options: Options] \| `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-sort-definitions/docs/README.md b/packages/remark-sort-definitions/docs/README.md index b403e73..94bc290 100644 --- a/packages/remark-sort-definitions/docs/README.md +++ b/packages/remark-sort-definitions/docs/README.md @@ -24,17 +24,17 @@ Options type for the remark-sort-definitions plugin. | Name | Type | Description | | :------ | :------ | :------ | -| `algorithm?` | ``"numeric-first"`` \| ``"alphanumeric-first"`` | This option determines the sorting preference used when reordering definitions. `numeric-first` will put definitions with purely numeric ids first, sorted from least (i.e. 1) to greatest, followed by any remaining definitions sorted [naturally][5]. `alphanumeric-first` will put definitions with alphanumeric ids (i.e. any id that cannot be parsed into an integer) first, sorted naturally, followed by any remaining definitions sorted from least (i.e. 1) to greatest. **`Default`** "alphanumeric-first" | +| `algorithm?` | ``"numeric-first"`` \| ``"alphanumeric-first"`` | This option determines the sorting preference used when reordering definitions. `numeric-first` will put definitions with purely numeric ids first, sorted from least (i.e. 1) to greatest, followed by any remaining definitions sorted [naturally][5]. `alphanumeric-first` will put definitions with alphanumeric ids (i.e. any id that cannot be parsed into an integer) first, sorted naturally, followed by any remaining definitions sorted from least (i.e. 1) to greatest. **`Default`** ```ts "alphanumeric-first" ``` | #### Defined in -[packages/remark-sort-definitions/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/1d6f92d/packages/remark-sort-definitions/src/index.ts#L12) +[packages/remark-sort-definitions/src/index.ts:12](https://github.com/Xunnamius/unified-utils/blob/7833113/packages/remark-sort-definitions/src/index.ts#L12) ## Functions ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that takes a Root node as input and returns the same node with all definition nodes ordered with respect to the chosen @@ -44,13 +44,13 @@ with all definition nodes ordered with respect to the chosen | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | [options: Options] \| `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | [options: Options] \| `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946 diff --git a/packages/remark-tight-comments/docs/README.md b/packages/remark-tight-comments/docs/README.md index 273dfc6..a298e83 100644 --- a/packages/remark-tight-comments/docs/README.md +++ b/packages/remark-tight-comments/docs/README.md @@ -12,7 +12,7 @@ remark-tight-comments ### default -▸ **default**(`this`, `...settings`): `void` \| `Transformer`<`Root`, `Root`\> +▸ **default**(`this`, `...parameters`): `undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> A remark plugin that ensures tight spacing between HTML comments and select other mdast nodes under certain conditions. @@ -21,13 +21,13 @@ other mdast nodes under certain conditions. | Name | Type | | :------ | :------ | -| `this` | `Processor`<`void`, `Root`, `void`, `void`\> | -| `...settings` | `void`[] | +| `this` | `Processor`\<`undefined`, `undefined`, `undefined`, `undefined`, `undefined`\> | +| `...parameters` | `void`[] | #### Returns -`void` \| `Transformer`<`Root`, `Root`\> +`undefined` \| `void` \| `Transformer`\<`Root`, `Root`\> #### Defined in -node_modules/unified/index.d.ts:531 +node_modules/unified/lib/index.d.ts:946