This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@mdxvac/fs-utils

DEPRECATED: Please consider using the plugin astro-m2dx, which bundles all features from the @mdxvac plugins in one plugin (completely opt-in).

Some utilities to work with the file system, e.g. to find files in parent folders.

Content

• Content
• What is this?
• When should I use this?
• Install
• Use

What is this?

An NPM package with a few utilities to work with configuration files in the file system. It also provides a cached variant, if you work in a static context, e.g. with a Static Site Generator (SSG).

When should I use this?

You shouldn't, it is meant for internal use in the @mdxvac plugins, but not tested for general purpose.

If you work with configuration files placed in the file system relative to your subject file, you usually want to find the closest or all files looking up the directory tree. Then you can use the functions findUp (finding the closest) and findUpAll (finding all, up to a stop directory).

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install -D @mdxvac/fs-utils

Use

Example usages:

const file = "src/pages/docs/install/my-content.mdx";

if (await exists(file)) {
  const howToRender = await findUp("how-to-render.json", file);

  const yaml = await findUpAll("_frontmatter.yaml", file);
  const frontmatter = deepMerge(yaml.map(c => loadYAML(c)));

  ...
}