The Wayback Machine - https://web.archive.org/web/20220323002118/https://github.com/unifiedjs/unified/discussions/170
Skip to content

Sharing variables between plugins #170

Answered by wooorm
robinmetral asked this question in Q&A
Sharing variables between plugins #170
@robinmetral robinmetral
Oct 21, 2021 · 2 answers · 3 replies
Answered by wooorm Return to top

robinmetral
Oct 21, 2021

Hiya!

First of, apologies if this is already documented or discussed elsewhere—I assume it is since it's a pretty basic thing to do, but I couldn't find anything.

I'm wondering if it's possible to share data between plugins.

My use case is that I want to get a variable from my markdown's frontmatter, and pass it as a page title to rehype-document:

unified()
    .use(remarkParse)
    .use(remarkFrontmatter, ["yaml"])
    /* Parse frontmatter with yaml-js */
    .use(() => (tree) => {
      const yamlFrontmatter = (tree.children[0] as FrontmatterContent).value;
      const jsFrontmatter = yaml.load(yamlFrontmatter);
      console.log(jsFrontmatter); // 👈 how can I get the title from here...
    })
    .use(remarkRehype)
    .use(rehypeDocument, { title: frontmatter.title }) // 👈 ...to here?
    .use(rehypeStringify)
    .process(file)
    .then((file) => {
      console.error(reporter(file));
      console.log(String(file));
    });

Thank in advance for the help—I hope this makes sense and I'm not doing something obviously wrong 😅
Answered by wooorm Oct 21, 2021

Yes, it is possible.
Note that rehype-meta is much more powerful than rehype-document and supports this example! You can also use both rehype-document and rehype-meta — the first is more about the document structure coming from markdown, the second is about all your SEO/OG/etc needs.

// ...
.use(remarkFrontmatter, ["yaml"])
.use(() => (tree, file) => {
  const head = tree.children[0]
  if (head && head.type === 'yaml') {
    file.data.matter = yaml.load(yamlFrontmatter);
  }
})
// ...
.use(rehypeMeta) // It works!

This is done by sharing metadata on the file. The convention for parsed frontmatter is to go into file.data.matter. And rehype-meta accepts that!

View full answer

Replies

2 suggested answers
·
3 replies
Oldest Newest Top
edited

wooorm
Oct 21, 2021
Maintainer

Yes, it is possible.
Note that rehype-meta is much more powerful than rehype-document and supports this example! You can also use both rehype-document and rehype-meta — the first is more about the document structure coming from markdown, the second is about all your SEO/OG/etc needs.

// ...
.use(remarkFrontmatter, ["yaml"])
.use(() => (tree, file) => {
  const head = tree.children[0]
  if (head && head.type === 'yaml') {
    file.data.matter = yaml.load(yamlFrontmatter);
  }
})
// ...
.use(rehypeMeta) // It works!

This is done by sharing metadata on the file. The convention for parsed frontmatter is to go into file.data.matter. And rehype-meta accepts that!
3 replies
@robinmetral

robinmetral Oct 21, 2021
Author

Ah nice, so basically you can usually store custom data on the file itself
@wooorm

wooorm Oct 21, 2021
Maintainer

if it’s data about a file, that’s a spot, yep
@robinmetral

robinmetral Oct 21, 2021
Author

Awesome, thanks 🙌
Answer selected by robinmetral

This comment was marked as spam.

Sign in to view
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Category
Q&A
Labels
None yet
3 participants
@robinmetral @wooorm @Notddzx1