Skip to content

Commit

Permalink
Update dev-dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Apr 23, 2024
1 parent 40fe9ff commit 6c2cc7f
Show file tree
Hide file tree
Showing 8 changed files with 395 additions and 395 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ jobs:
name: ${{matrix.node}}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{matrix.node}}
- run: npm install
- run: npm test
- uses: codecov/codecov-action@v3
- uses: codecov/codecov-action@v4
strategy:
matrix:
node:
Expand Down
396 changes: 198 additions & 198 deletions doc/plugins.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
"c8": "^9.0.0",
"hast-util-assert": "^4.0.0",
"prettier": "^3.0.0",
"remark-cli": "^11.0.0",
"remark-preset-wooorm": "^9.0.0",
"remark-cli": "^12.0.0",
"remark-preset-wooorm": "^10.0.0",
"type-coverage": "^2.0.0",
"typescript": "^5.0.0",
"unified": "^11.0.0",
"unist-util-remove-position": "^5.0.0",
"vfile": "^6.0.0",
"xo": "^0.57.0"
"xo": "^0.58.0"
},
"scripts": {
"build": "tsc --build --clean && tsc --build && type-coverage",
Expand Down
34 changes: 17 additions & 17 deletions packages/rehype-cli/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ Command line interface to inspect and change HTML files with **[rehype][]**.

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [CLI](#cli)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [CLI](#cli)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)

## What is this?

Expand Down Expand Up @@ -112,13 +112,13 @@ More info on all these options is available at [`unified-args`][unified-args],
which does the work.
`rehype-cli` is `unified-args` preconfigured to:

* load `rehype-` plugins
* search for HTML extensions (`.html`, `.htm`, `.xht`, `.xhtml`)
* ignore paths found in [`.rehypeignore` files][ignore-file]
* load configuration from
[`.rehyperc`, `.rehyperc.js`, etc files][config-file]
* use configuration from
[`rehype` fields in `package.json` files][config-file]
* load `rehype-` plugins
* search for HTML extensions (`.html`, `.htm`, `.xht`, `.xhtml`)
* ignore paths found in [`.rehypeignore` files][ignore-file]
* load configuration from
[`.rehyperc`, `.rehyperc.js`, etc files][config-file]
* use configuration from
[`rehype` fields in `package.json` files][config-file]

## Compatibility

Expand Down
84 changes: 42 additions & 42 deletions packages/rehype-parse/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,27 @@

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeParse[, options])`](#unifieduserehypeparse-options)
* [`ErrorCode`](#errorcode)
* [`ErrorSeverity`](#errorseverity)
* [`Options`](#options)
* [Examples](#examples)
* [Example: fragment versus document](#example-fragment-versus-document)
* [Example: whitespace around and inside `<html>`](#example-whitespace-around-and-inside-html)
* [Example: parse errors](#example-parse-errors)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeParse[, options])`](#unifieduserehypeparse-options)
* [`ErrorCode`](#errorcode)
* [`ErrorSeverity`](#errorseverity)
* [`Options`](#options)
* [Examples](#examples)
* [Example: fragment versus document](#example-fragment-versus-document)
* [Example: whitespace around and inside `<html>`](#example-whitespace-around-and-inside-html)
* [Example: parse errors](#example-parse-errors)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)

## What is this?

Expand Down Expand Up @@ -119,8 +119,8 @@ Plugin to add support for parsing from HTML.

###### Parameters

* `options` ([`Options`][api-options], optional)
— configuration
* `options` ([`Options`][api-options], optional)
— configuration

###### Returns

Expand Down Expand Up @@ -203,12 +203,12 @@ type ErrorCode =
Error severity (TypeScript type).
* `0` or `false`
— turn the parse error off
* `1` or `true`
— turn the parse error into a warning
* `2`
— turn the parse error into an actual error: processing stops
* `0` or `false`
— turn the parse error off
* `1` or `true`
— turn the parse error into a warning
* `2`
— turn the parse error into an actual error: processing stops
###### Type
Expand All @@ -228,19 +228,19 @@ Configuration (TypeScript type).
###### Fields
* `fragment` (`boolean`, default: `false`)
— whether to parse as a fragment; by default unopened `html`, `head`, and
`body` elements are opened
* `emitParseErrors` (`boolean`, default: `false`)
— whether to emit [parse errors][parse-errors] while parsing
* `space` (`'html'` or `'svg'`, default: `'html'`)
— which space the document is in
* `verbose` (`boolean`, default: `false`)
— add extra positional info about attributes, start tags, and end tags
* [`[key in ErrorCode]`][api-error-code]
([`ErrorSeverity`][api-error-severity], default: `1` if
`options.emitParseErrors`, otherwise `0`)
— configure specific [parse errors][parse-errors]
* `fragment` (`boolean`, default: `false`)
— whether to parse as a fragment; by default unopened `html`, `head`, and
`body` elements are opened
* `emitParseErrors` (`boolean`, default: `false`)
— whether to emit [parse errors][parse-errors] while parsing
* `space` (`'html'` or `'svg'`, default: `'html'`)
— which space the document is in
* `verbose` (`boolean`, default: `false`)
— add extra positional info about attributes, start tags, and end tags
* [`[key in ErrorCode]`][api-error-code]
([`ErrorSeverity`][api-error-severity], default: `1` if
`options.emitParseErrors`, otherwise `0`)
— configure specific [parse errors][parse-errors]
## Examples
Expand Down
174 changes: 87 additions & 87 deletions packages/rehype-stringify/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@

## Contents

* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeStringify[, options])`](#unifieduserehypestringify-options)
* [`CharacterReferences`](#characterreferences)
* [`Options`](#options)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(rehypeStringify[, options])`](#unifieduserehypestringify-options)
* [`CharacterReferences`](#characterreferences)
* [`Options`](#options)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [Sponsor](#sponsor)
* [License](#license)

## What is this?

Expand Down Expand Up @@ -121,8 +121,8 @@ Plugin to add support for serializing to HTML.

###### Parameters

* `options` ([`Options`][api-options], optional)
— configuration
* `options` ([`Options`][api-options], optional)
— configuration

###### Returns

Expand All @@ -143,12 +143,12 @@ How to serialize character references (TypeScript type).
###### Fields

* `useNamedReferences` (`boolean`, default: `false`)
— prefer named character references (`&amp;`) where possible
* `omitOptionalSemicolons` (`boolean`, default: `false`)
— whether to omit semicolons when possible
* `useShortestReferences` (`boolean`, default: `false`)
— prefer the shortest possible reference, if that results in less bytes
* `useNamedReferences` (`boolean`, default: `false`)
— prefer named character references (`&amp;`) where possible
* `omitOptionalSemicolons` (`boolean`, default: `false`)
— whether to omit semicolons when possible
* `useShortestReferences` (`boolean`, default: `false`)
— prefer the shortest possible reference, if that results in less bytes

### `Options`

Expand All @@ -169,69 +169,69 @@ Configuration (TypeScript type).
###### Fields

* `allowDangerousCharacters` (`boolean`, default: `false`)
— do not encode some characters which cause XSS vulnerabilities in older
browsers
* `allowDangerousHtml` (`boolean`, default: `false`)
— allow [`Raw`][raw] nodes and insert them as raw HTML; when `false`, `Raw`
nodes are encoded
* `allowParseErrors` (`boolean`, default: `false`)
— do not encode characters which cause parse errors (even though they
work), to save bytes; not used in the SVG space.
* `bogusComments` (`boolean`, default: `false`)
— use “bogus comments” instead of comments to save byes: `<?charlie>`
instead of `<!--charlie-->`
* `characterReferences` ([`CharacterReferences`][api-character-references],
optional)
— configure how to serialize character references
* `closeEmptyElements` (`boolean`, default: `false`)
— close SVG elements without any content with slash (`/`) on the opening
tag instead of an end tag: `<circle />` instead of `<circle></circle>`;
see `tightSelfClosing` to control whether a space is used before the slash;
not used in the HTML space
* `closeSelfClosing` (`boolean`, default: `false`)
— close self-closing nodes with an extra slash (`/`): `<img />` instead of
`<img>`; see `tightSelfClosing` to control whether a space is used before
the slash; not used in the SVG space.
* `collapseEmptyAttributes` (`boolean`, default: `false`)
— collapse empty attributes: get `class` instead of `class=""`; not used in
the SVG space; boolean attributes (such as `hidden`) are always collapsed
* `omitOptionalTags` (`boolean`, default: `false`)
— omit optional opening and closing tags; to illustrate, in
`<ol><li>one</li><li>two</li></ol>`, both `</li>` closing tags can be
omitted, the first because it’s followed by another `li`, the last because
it’s followed by nothing; not used in the SVG space
* `preferUnquoted` (`boolean`, default: `false`)
— leave attributes unquoted if that results in less bytes; not used in the
SVG space
* `quote` (`'"'` or `"'"`, default: `'"'`)
— preferred quote to use
* `quoteSmart` (`boolean`, default: `false`)
— use the other quote if that results in less bytes
* `space` (`'html'` or `'svg'`, default: `'html'`)
— which space the document is in; when an `<svg>` element is found in the
HTML space, this package already automatically switches to and from the SVG
* `tightAttributes` (`boolean`, default: `false`)
— join attributes together, without whitespace, if possible: get
`class="a b"title="c d"` instead of `class="a b" title="c d"` to save
bytes; not used in the SVG space
* `tightCommaSeparatedLists` (`boolean`, default: `false`)
— join known comma-separated attribute values with just a comma (`,`),
instead of padding them on the right as well (`,␠`, where `` represents a
space)
* `tightDoctype` (`boolean`, default: `false`)
— drop unneeded spaces in doctypes: `<!doctypehtml>` instead of
`<!doctype html>` to save bytes
* `tightSelfClosing` (`boolean`, default: `false`).
— do not use an extra space when closing self-closing elements: `<img/>`
instead of `<img />`; only used if `closeSelfClosing: true` or
`closeEmptyElements: true`
* `upperDoctype` (`boolean`, default: `false`).
— use a `<!DOCTYPE…` instead of `<!doctype…`; useless except for XHTML
* `voids` (`Array<string>`, default:
[`html-void-elements`][html-void-elements])
— tag names of elements to serialize without closing tag; not used in the
SVG space
* `allowDangerousCharacters` (`boolean`, default: `false`)
— do not encode some characters which cause XSS vulnerabilities in older
browsers
* `allowDangerousHtml` (`boolean`, default: `false`)
— allow [`Raw`][raw] nodes and insert them as raw HTML; when `false`, `Raw`
nodes are encoded
* `allowParseErrors` (`boolean`, default: `false`)
— do not encode characters which cause parse errors (even though they
work), to save bytes; not used in the SVG space.
* `bogusComments` (`boolean`, default: `false`)
— use “bogus comments” instead of comments to save byes: `<?charlie>`
instead of `<!--charlie-->`
* `characterReferences` ([`CharacterReferences`][api-character-references],
optional)
— configure how to serialize character references
* `closeEmptyElements` (`boolean`, default: `false`)
— close SVG elements without any content with slash (`/`) on the opening
tag instead of an end tag: `<circle />` instead of `<circle></circle>`;
see `tightSelfClosing` to control whether a space is used before the slash;
not used in the HTML space
* `closeSelfClosing` (`boolean`, default: `false`)
— close self-closing nodes with an extra slash (`/`): `<img />` instead of
`<img>`; see `tightSelfClosing` to control whether a space is used before
the slash; not used in the SVG space.
* `collapseEmptyAttributes` (`boolean`, default: `false`)
— collapse empty attributes: get `class` instead of `class=""`; not used in
the SVG space; boolean attributes (such as `hidden`) are always collapsed
* `omitOptionalTags` (`boolean`, default: `false`)
— omit optional opening and closing tags; to illustrate, in
`<ol><li>one</li><li>two</li></ol>`, both `</li>` closing tags can be
omitted, the first because it’s followed by another `li`, the last because
it’s followed by nothing; not used in the SVG space
* `preferUnquoted` (`boolean`, default: `false`)
— leave attributes unquoted if that results in less bytes; not used in the
SVG space
* `quote` (`'"'` or `"'"`, default: `'"'`)
— preferred quote to use
* `quoteSmart` (`boolean`, default: `false`)
— use the other quote if that results in less bytes
* `space` (`'html'` or `'svg'`, default: `'html'`)
— which space the document is in; when an `<svg>` element is found in the
HTML space, this package already automatically switches to and from the SVG
* `tightAttributes` (`boolean`, default: `false`)
— join attributes together, without whitespace, if possible: get
`class="a b"title="c d"` instead of `class="a b" title="c d"` to save
bytes; not used in the SVG space
* `tightCommaSeparatedLists` (`boolean`, default: `false`)
— join known comma-separated attribute values with just a comma (`,`),
instead of padding them on the right as well (`,␠`, where `` represents a
space)
* `tightDoctype` (`boolean`, default: `false`)
— drop unneeded spaces in doctypes: `<!doctypehtml>` instead of
`<!doctype html>` to save bytes
* `tightSelfClosing` (`boolean`, default: `false`).
— do not use an extra space when closing self-closing elements: `<img/>`
instead of `<img />`; only used if `closeSelfClosing: true` or
`closeEmptyElements: true`
* `upperDoctype` (`boolean`, default: `false`).
— use a `<!DOCTYPE…` instead of `<!doctype…`; useless except for XHTML
* `voids` (`Array<string>`, default:
[`html-void-elements`][html-void-elements])
— tag names of elements to serialize without closing tag; not used in the
SVG space

## Syntax

Expand Down

0 comments on commit 6c2cc7f

Please sign in to comment.