feat: change compile option to files

[ignatiusmb]

This PR introduces a new option to traverse called files, which replaces compile option, that filters the files in the directory tree and executes the hydrate function, which is now a required parameter.

The HydrateChunk also receives marker as a new passthrough argument for convenience and full control of the renderer.

---

The compile option in traverse is confusing and hard to differentiate between the compile function that is exported. It also checks if it returns true for a path and.. calls compile with the same hydrate? To make it even more confusing, it checks if the returned data is truthy, else it will.. executes hydrate again (what)?

Okay, the first one which passes it to the compile function wants the content to be rendered to HTML. The !hydrate checking also kind of makes sense in a way that we just want to compile a markdown file and get its content, but in that case it's better to just call the compile function directly without passing in hydrate. For cases where we want to compile all the markdown files in a or multiple directories, we can do them with buffer + parse and now marker.render

import { compile, traverse } from 'marqua/fs';

const data = traverse('content', ({ buffer, marker, parse }) => {
  const { content, metadata } = parse(buffer.toString('utf-8'));
  return { ...metadata, content: marker.render(content) };
});

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
marqua	✅ Ready (Inspect)	Visit Preview	Jan 1, 2024 9:58am