npmpackage.info

Gathering detailed insights and metrics for rehype-rewrite

Other packages similar to rehype-rewrite

rehype-external-links

3.0.0

rehype plugin to automatically add `target` and `rel` attributes to external links

remark-rehype

11.1.1

remark plugin that turns markdown into HTML to support rehype

rehype-slug

6.0.0

rehype plugin to add `id` attributes to headings

rehype-raw

7.0.0

rehype plugin to reparse the tree (and raw nodes)

Gathering detailed insights and metrics for rehype-rewrite

rehype-rewrite

Rewrite element with rehype.

4.0.2

MIT

TypeScript

8,642,425 4.2

Installations

npm install rehype-rewrite

Pull Requests

Open

0

Total

33

Closed

14

Merged

19

Issues

Open

1

Total

2

Closed

1

Releases

v4.0.2

Published on 26 Nov 2023

v4.0.1

Published on 25 Nov 2023

v4.0.0

Published on 28 Sept 2023

v3.0.6

Published on 14 Mar 2022

v3.0.5

Published on 05 Mar 2022

v3.0.4

Published on 05 Oct 2021

View all 21 releases

Developer

jaywcjlove

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=16.0.0

Typescript Support

No

Node Version

18.18.2

NPM Version

9.8.1 Statistics

21 Stars

106 Commits

1 Forks

3 Watching

2 Branches

2 Contributors

Updated on 27 Aug 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

8,642,425

Last day

-13.5%

20,740

Compared to previous day

Last week

0.1%

118,923

Compared to previous week

Last month

15.5%

504,455

Compared to previous month

Last year

99.2%

5,079,427

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

unified unist-util-visit hast-util-select

Dev Dependencies

rehype rehype-stringify rehype-raw remark-parse remark-rehype tsbb

Versions

rehype-rewrite

Rewrite element with rehype.

Installation

This package is ESM only: Node 12+ is needed to use it and it must be import instead of require.

1npm install rehype-rewrite

Usage

🚧 Migrate from rehype-rewrite ~~v2.x~~ to v3.x.

1rehype()
2- .use(rehypeRewrite, (node, index, parent) => {})
3+ .use(rehypeRewrite, {
4+   rewrite: (node, index, parent) => {}
5+ })

1import { rehype } from 'rehype';
2import rehypeRewrite from 'rehype-rewrite';
3import stringify from 'rehype-stringify';
4
5const html = `<h1>header</h1>`;
6const htmlStr = rehype()
7  .data('settings', { fragment: true })
8  .use(rehypeRewrite, {
9    rewrite: (node, index, parent) => {
10      if(node.type == 'text' && node.value == 'header') {
11        node.value = ''
12      }
13    }
14  })
15  .use(stringify)
16  .processSync(html)
17  .toString()

1<h1>header</h1>

Output:

1<h1></h1>

Options

1import { Plugin } from 'unified';
2import { Root, Element, ElementContent, RootContent } from 'hast';
3/** Get the node tree source code string */
4export declare const getCodeString: (data?: ElementContent[], code?: string) => string;
5export declare type RehypeRewriteOptions = {
6  /**
7   * Select an element to be wrapped. Expects a string selector that can be passed to hast-util-select ([supported selectors](https://github.com/syntax-tree/hast-util-select/blob/master/readme.md#support)).
8   * If `selector` is not set then wrap will check for a body all elements.
9   */
10  selector?: string;
11  /** Rewrite Element. */
12  rewrite(node: Root | RootContent, index: number | null, parent: Root | Element | null): void;
13};
14declare const remarkRewrite: Plugin<[RehypeRewriteOptions?], Root>;
15export default remarkRewrite;

`selector?: string;`

Select an element to be wrapped. Expects a string selector that can be passed to hast-util-select (supported selectors). If selector is not set then wrap will check for a body all elements.

`rewrite(node, index, parent): void;`

Rewrite element.

Example

Example 1

1import { rehype } from 'rehype';
2import rehypeRewrite from 'rehype-rewrite';
3import stringify from 'rehype-stringify';
4
5const html = `<h1>header</h1><h1>header</h1><h1 class="title3">header</h1>`;
6const htmlStr = rehype()
7  .data('settings', { fragment: true })
8  .use(rehypeRewrite, {
9    selector: 'h1',
10    rewrite: (node) => {
11      if (node.type === 'element') {
12        node.properties.className = 'test';
13      }
14    }
15  })
16  .use(stringify)
17  .processSync(html)
18  .toString()

1<h1>header</h1>
2<h1>header</h1>
3<h1 class="title3">header</h1>

Output:

1<h1 class="test">header</h1>
2<h1 class="test">header</h1>
3<h1 class="test">header</h1>

Example 2

1import { rehype } from 'rehype';
2import rehypeRewrite from 'rehype-rewrite';
3import stringify from 'rehype-stringify';
4
5const html = `<h1>header</h1>`;
6const htmlStr = rehype()
7  .use(rehypeRewrite, {
8    rewrite: (node) => {
9      if (node.type == 'element' && node.tagName == 'body') {
10        node.properties = { ...node.properties, style: 'color:red;'}
11      }
12    }
13  })
14  .use(stringify)
15  .processSync(html)
16  .toString()

1<h1>header</h1>

Output:

1<html><head></head><body style="color:red;"><h1>header</h1></body></html>

Example 3

1import { rehype } from 'rehype';
2import rehypeRewrite from 'rehype-rewrite';
3import stringify from 'rehype-stringify';
4
5const html = `<h1>hello</h1>`;
6const htmlStr = rehype()
7  .data('settings', { fragment: true })
8  .use(rehypeRewrite, {
9    rewrite: (node) => {
10      if (node.type == 'element' && node.tagName == 'h1') {
11        node.children = [ ...node.children, {
12          type: 'element',
13          tagName: 'span',
14          properties: {},
15          children: [
16            {type: 'text', value: ' world'}
17          ]
18        }]
19      }
20    }
21  })
22  .use(stringify)
23  .processSync(html)
24  .toString()

1<h1>hello</h1>

Output:

1<h1>hello<span> world</span></h1>

Example 4

1import { unified } from 'unified';
2import remarkParse from 'remark-parse';
3import rehypeRaw from 'rehype-raw';
4import remark2rehype from 'remark-rehype';
5import rehypeRewrite from 'rehype-rewrite';
6import stringify from 'rehype-stringify';
7
8const html = `<h1>hello</h1>`;
9const htmlStr = unified()
10  .use(remarkParse)
11  .use(remark2rehype, { allowDangerousHtml: true })
12  .use(rehypeRaw)
13  .use(rehypeRewrite, {
14    rewrite: (node) => {
15      if (node.type == 'element' && node.tagName == 'h1') {
16        node.properties = { ...node.properties, style: 'color:red;' }
17      }
18    }
19  })
20  .use(stringify)
21  .processSync(html)
22  .toString()

1<h1>hello</h1>

Output:

1<h1 style="color:red;">Hello World!</h1>

rehype-video Add improved video syntax: links to .mp4 and .mov turn into videos.
rehype-attr New syntax to add attributes to Markdown.
rehype-ignore Ignore content display via HTML comments, Shown in GitHub readme, excluded in HTML.
remark-github-blockquote-alert Remark plugin to add support for GitHub Alert.

Contributors

As always, thanks to our amazing contributors!

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pr.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/jaywcjlove/rehype-rewrite/pr.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:21
Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:44
Warn: npmCommand not pinned by hash: .github/workflows/pr.yml:16
Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 7 third-party GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to rehype-rewrite

Other packages similar to rehype-rewrite

rehype-rewrite

Installations

Pull Requests

0

33

14

19

Issues

1

2

1

Releases

Developer

Developer Guide

ESM

>=16.0.0

No

18.18.2

9.8.1

Statistics

Languages

Total Downloads

8,642,425

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

rehype-rewrite

Installation

Usage

Options

selector?: string;

rewrite(node, index, parent): void;

Example

Example 1

Example 2

Example 3

Example 4

Related

Contributors

License

10

10

10

10

10

0

0

0

0

0

0

0

0

4.2

/10

`selector?: string;`

`rewrite(node, index, parent): void;`