recma-export-filepath


A recma plugin to expose the filepath as a named export.

Table of Contents

- Installation
- Usage
- API
- Options
- Compatibility
- License

Installation

``sh
npm install recma-export-filepath
`

Usage

This recma plugin exposes the filepath of the current file as a named export.

For example, given a file named example.mdx with the following contents:

`mdx
Hello 👋
`

The following script:

`js
import { compile } from '@mdx-js/mdx'
import recmaExportFilepath from 'recma-export-filepath'
import { read } from 'to-vfile'

const { contents } = await compile(await read('example.mdx'), {
jsx: true,
recmaPlugins: [recmaExportFilepath]
})

console.log(contents)
`

Roughly yields:

`jsx
export const filepath = 'example.mdx'

export default function MDXContent() {
return

Hello 👋


}
`

API

The default export is a recma plugin.

$3

- absolute (boolean, default: false) — If true, use an absolute path. By default a relative
path is used.
- cwd (string) The current working directory to use when generating a relative file path.
- name (string, default: 'filepath') — The name to export the file path as.

In addition it supports unist-util-mdx-define`
options.

Compatibility

This project is compatible with Node.js 16 or greater.

License

MIT © Remco Haszing