Repository: rehypejs/rehype-raw
Branch: main
Commit: 839c43a2b60f
Files: 13
Total size: 14.8 KB

Directory structure:
gitextract_q56bnwjx/

├── .editorconfig
├── .github/
│   └── workflows/
│       ├── bb.yml
│       └── main.yml
├── .gitignore
├── .npmrc
├── .prettierignore
├── index.js
├── lib/
│   └── index.js
├── license
├── package.json
├── readme.md
├── test.js
└── tsconfig.json

================================================
FILE CONTENTS
================================================

================================================
FILE: .editorconfig
================================================
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true


================================================
FILE: .github/workflows/bb.yml
================================================
jobs:
  main:
    runs-on: ubuntu-latest
    steps:
      - uses: unifiedjs/beep-boop-beta@main
        with:
          repo-token: ${{secrets.GITHUB_TOKEN}}
name: bb
on:
  issues:
    types: [closed, edited, labeled, opened, reopened, unlabeled]
  pull_request_target:
    types: [closed, edited, labeled, opened, reopened, unlabeled]


================================================
FILE: .github/workflows/main.yml
================================================
jobs:
  main:
    name: ${{matrix.node}}
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{matrix.node}}
      - run: npm install
      - run: npm test
      - uses: codecov/codecov-action@v4
    strategy:
      matrix:
        node:
          - lts/hydrogen
          - node
name: main
on:
  - pull_request
  - push


================================================
FILE: .gitignore
================================================
*.d.ts
*.log
*.map
*.tsbuildinfo
.DS_Store
coverage/
node_modules/
yarn.lock


================================================
FILE: .npmrc
================================================
ignore-scripts=true
package-lock=false


================================================
FILE: .prettierignore
================================================
coverage/
*.md


================================================
FILE: index.js
================================================
/**
 * @typedef {import('./lib/index.js').Options} Options
 */

export {default} from './lib/index.js'


================================================
FILE: lib/index.js
================================================
/**
 * @import {Options as RawOptions} from 'hast-util-raw'
 * @import {Root} from 'hast'
 * @import {VFile} from 'vfile'
 */

/**
 * @typedef {Omit<RawOptions, 'file'>} Options
 *   Configuration.
 */

import {raw} from 'hast-util-raw'

/**
 * Parse the tree (and raw nodes) again, keeping positional info okay.
 *
 * @param {Options | null | undefined}  [options]
 *   Configuration (optional).
 * @returns
 *   Transform.
 */
export default function rehypeRaw(options) {
  /**
   * @param {Root} tree
   *   Tree.
   * @param {VFile} file
   *   File.
   * @returns {Root}
   *   New tree.
   */
  return function (tree, file) {
    // Assume root in -> root out.
    const result = /** @type {Root} */ (raw(tree, {...options, file}))
    return result
  }
}


================================================
FILE: license
================================================
(The MIT License)

Copyright (c) Titus Wormer <tituswormer@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


================================================
FILE: package.json
================================================
{
  "author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
  "bugs": "https://github.com/rehypejs/rehype-raw/issues",
  "contributors": [
    "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
  ],
  "dependencies": {
    "@types/hast": "^3.0.0",
    "hast-util-raw": "^9.0.0",
    "vfile": "^6.0.0"
  },
  "description": "rehype plugin to reparse the tree (and raw nodes)",
  "devDependencies": {
    "@types/node": "^22.0.0",
    "c8": "^10.0.0",
    "prettier": "^3.0.0",
    "rehype-stringify": "^10.0.0",
    "remark-cli": "^12.0.0",
    "remark-parse": "^11.0.0",
    "remark-preset-wooorm": "^10.0.0",
    "remark-rehype": "^11.0.0",
    "type-coverage": "^2.0.0",
    "typescript": "^5.0.0",
    "unified": "^11.0.0",
    "unist-util-visit": "^5.0.0",
    "xo": "^0.59.0"
  },
  "exports": "./index.js",
  "files": [
    "index.d.ts.map",
    "index.d.ts",
    "index.js",
    "lib/"
  ],
  "funding": {
    "type": "opencollective",
    "url": "https://opencollective.com/unified"
  },
  "keywords": [
    "html",
    "plugin",
    "raw",
    "rehype-plugin",
    "rehype",
    "unified"
  ],
  "license": "MIT",
  "name": "rehype-raw",
  "prettier": {
    "bracketSpacing": false,
    "singleQuote": true,
    "semi": false,
    "tabWidth": 2,
    "trailingComma": "none",
    "useTabs": false
  },
  "version": "7.0.0",
  "remarkConfig": {
    "plugins": [
      "remark-preset-wooorm"
    ]
  },
  "repository": "rehypejs/rehype-raw",
  "scripts": {
    "build": "tsc --build --clean && tsc --build && type-coverage",
    "format": "remark --frail --output --quiet -- . && prettier --log-level warn --write -- . && xo --fix",
    "test": "npm run build && npm run format && npm run test-coverage",
    "test-api": "node --conditions development test.js",
    "test-coverage": "c8 --100 --reporter lcov -- npm run test-api"
  },
  "sideEffects": false,
  "typeCoverage": {
    "atLeast": 100,
    "detail": true,
    "ignoreCatch": true,
    "strict": true
  },
  "type": "module",
  "xo": {
    "prettier": true
  }
}


================================================
FILE: readme.md
================================================
# rehype-raw

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]

**[rehype][]** plugin to parse the tree (and raw nodes) again, keeping
positional info okay.

## 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(rehypeRaw[, options])`](#unifieduserehyperaw-options)
  * [`Options`](#options)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Contribute](#contribute)
* [License](#license)

## What is this?

This package is a [unified][] ([rehype][]) plugin to parse a document again.
To understand how it works, requires knowledge of ASTs (specifically, [hast][]).
This plugin passes each node and embedded raw HTML through an HTML parser
([`parse5`][parse5]), to recreate a tree exactly as how a browser would parse
it, while keeping the original data and positional info intact.

**unified** is a project that transforms content with abstract syntax trees
(ASTs).
**rehype** adds support for HTML to unified.
**hast** is the HTML AST that rehype uses.
This is a rehype plugin that parses the tree again.

## When should I use this?

This plugin is particularly useful when coming from markdown and wanting to
support HTML embedded inside that markdown (which requires passing
`allowDangerousHtml: true` to `remark-rehype`).
Markdown dictates how, say, a list item or emphasis can be parsed.
We can use that to turn the markdown syntax tree into an HTML syntax tree.
But markdown also dictates that things that look like HTML, are passed through
untouched, even when it just looks like XML but doesn’t really make sense, so we
can’t normally use these strings of “HTML” to create an HTML syntax tree.
This plugin can.
It can be used to take those strings of HTML and include them into the syntax
tree as actual nodes.

If your final result is HTML and you trust content, then “strings” are fine
(you can pass `allowDangerousHtml: true` to `rehype-stringify`, which passes
HTML through untouched).
But there are two main cases where a proper syntax tree is preferred:

* rehype plugins need a proper syntax tree as they operate on actual nodes to
  inspect or transform things, they can’t operate on strings of HTML
* other output formats (React, MDX, etc) need actual nodes and can’t handle
  strings of HTML

This plugin is built on [`hast-util-raw`][hast-util-raw], which does the work on
syntax trees.
rehype focusses on making it easier to transform content by abstracting such
internals away.

## Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

```sh
npm install rehype-raw
```

In Deno with [`esm.sh`][esmsh]:

```js
import rehypeRaw from 'https://esm.sh/rehype-raw@7'
```

In browsers with [`esm.sh`][esmsh]:

```html
<script type="module">
  import rehypeRaw from 'https://esm.sh/rehype-raw@7?bundle'
</script>
```

## Use

Say we have the following markdown file `example.md`:

```markdown
<div class="note">

A mix of *markdown* and <em>HTML</em>.

</div>
```

…and our module `example.js` looks as follows:

```js
import rehypeDocument from 'rehype-document'
import rehypeFormat from 'rehype-format'
import rehypeRaw from 'rehype-raw'
import rehypeStringify from 'rehype-stringify'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {read} from 'to-vfile'
import {unified} from 'unified'

const file = await unified()
  .use(remarkParse)
  .use(remarkRehype, {allowDangerousHtml: true})
  .use(rehypeRaw)
  .use(rehypeDocument, {title: '🙌'})
  .use(rehypeFormat)
  .use(rehypeStringify)
  .process(await read('example.md'))

console.log(String(file))
```

…now running `node example.js` yields:

```html
<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <title>🙌</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
  </head>
  <body>
    <div class="note">
      <p>A mix of <em>markdown</em> and <em>HTML</em>.</p>
    </div>
  </body>
</html>
```

## API

This package exports no identifiers.
The default export is [`rehypeRaw`][api-rehype-raw].

### `unified().use(rehypeRaw[, options])`

Parse the tree (and raw nodes) again, keeping positional info okay.

###### Parameters

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

###### Returns

Transform ([`Transformer`][transformer]).

### `Options`

Configuration (TypeScript type).

###### Fields

* `passThrough` (`Array<string>`, default: `[]`)
  — list of custom hast node types to pass through (as in, keep); this option
  is a bit advanced as it requires knowledge of ASTs, so we defer to the docs
  in [`hast-util-raw`][hast-util-raw]
* `tagfilter?` (`boolean | null | undefined`)
  — whether to disallow irregular tags in `raw` nodes according to GFM
  tagfilter (default: `false`);
  this affects the following tags,
  grouped by their kind:
  `RAWTEXT` (`iframe`, `noembed`, `noframes`, `style`, `xmp`),
  `RCDATA` (`textarea`, `title`),
  `SCRIPT_DATA` (`script`),
  `PLAINTEXT` (`plaintext`);
  when you know that you do not want authors to write these tags,
  you can enable this option to prevent their use from running amok.

## Types

This package is fully typed with [TypeScript][].
It exports the additional type [`Options`][api-options].

The `Raw` node type is registered by and exposed from
[`remark-rehype`][remark-rehype].

## Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, `rehype-raw@^7`, compatible
with Node.js 16.

## Security

The `allowDangerousHtml` option in [`remark-rehype`][remark-rehype] is
dangerous, so see that plugin on how to make it safe.
Otherwise, this plugin is safe.

## Contribute

See [`contributing.md`][contributing] in [`rehypejs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]

<!-- Definitions -->

[build-badge]: https://github.com/rehypejs/rehype-raw/workflows/main/badge.svg

[build]: https://github.com/rehypejs/rehype-raw/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/rehypejs/rehype-raw.svg

[coverage]: https://codecov.io/github/rehypejs/rehype-raw

[downloads-badge]: https://img.shields.io/npm/dm/rehype-raw.svg

[downloads]: https://www.npmjs.com/package/rehype-raw

[size-badge]: https://img.shields.io/bundlejs/size/rehype-raw

[size]: https://bundlejs.com/?q=rehype-raw

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/rehypejs/rehype/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[health]: https://github.com/rehypejs/.github

[contributing]: https://github.com/rehypejs/.github/blob/main/contributing.md

[support]: https://github.com/rehypejs/.github/blob/main/support.md

[coc]: https://github.com/rehypejs/.github/blob/main/code-of-conduct.md

[license]: license

[author]: https://wooorm.com

[typescript]: https://www.typescriptlang.org

[parse5]: https://github.com/inikulin/parse5

[unified]: https://github.com/unifiedjs/unified

[transformer]: https://github.com/unifiedjs/unified#transformer

[hast]: https://github.com/syntax-tree/hast

[hast-util-raw]: https://github.com/syntax-tree/hast-util-raw

[rehype]: https://github.com/rehypejs/rehype

[remark-rehype]: https://github.com/remarkjs/remark-rehype

[api-options]: #options

[api-rehype-raw]: #unifieduserehyperaw-options


================================================
FILE: test.js
================================================
/**
 * @import {Root} from 'hast'
 */

import assert from 'node:assert/strict'
import test from 'node:test'
import rehypeStringify from 'rehype-stringify'
import remarkParse from 'remark-parse'
import remarkRehype from 'remark-rehype'
import {unified} from 'unified'
import {visit} from 'unist-util-visit'
import rehypeRaw from 'rehype-raw'

test('rehypeRaw', async function (t) {
  await t.test('should expose the public api', async function () {
    assert.deepEqual(Object.keys(await import('rehype-raw')).sort(), [
      'default'
    ])
  })

  await t.test('should work', async function () {
    const file = await unified()
      .use(remarkParse)
      .use(remarkRehype, {allowDangerousHtml: true})
      .use(rehypeRaw)
      .use(function () {
        /**
         * @param {Root} root
         */
        return function (root) {
          visit(root, 'raw', function () {
            assert.fail()
          })
        }
      })
      .use(rehypeStringify).process(`<div class="note">

A mix of *markdown* and <em>HTML</em>.

</div>`)

    assert.equal(
      String(file),
      `<div class="note">
<p>A mix of <em>markdown</em> and <em>HTML</em>.</p>
</div>`
    )
  })

  await t.test('tagfilter', async function () {
    const file = await unified()
      .use(remarkParse)
      .use(remarkRehype, {allowDangerousHtml: true})
      .use(rehypeRaw, {tagfilter: true})
      .use(rehypeStringify)
      .process('<script>alert(1)</script>')

    assert.equal(String(file), '&#x3C;script>alert(1)&#x3C;/script>')
  })
})


================================================
FILE: tsconfig.json
================================================
{
  "compilerOptions": {
    "checkJs": true,
    "customConditions": ["development"],
    "declarationMap": true,
    "declaration": true,
    "emitDeclarationOnly": true,
    "exactOptionalPropertyTypes": true,
    "lib": ["es2022"],
    "module": "node16",
    "strict": true,
    "target": "es2022"
  },
  "exclude": ["coverage/", "node_modules/"],
  "include": ["**/*.js"]
}