recma-nextjs-static-props
Expose top-level identifiers in Next.js app.js
Installation
npm install recma-nexjs-static-props
Usage
This plugin is intended for use with Next.js and MDX.
import nextMDX from '@next/mdx'
import recmaNextjsStaticProps from 'recma-nextjs-static-props'
const withMDX = nextMDX({
options: {
recmaPlugins: [recmaNextjsStaticProps],
},
})
export default withMDX()
API
The default export is a recma plugin which exposes variables from the top-level scope in Next.js through getStaticProps.
Options
name: The name of the export to generate. (Default:'getStaticProps')include: A list to filter identifiers to include in the generated function. This list may include strings which must be matched exactly, a regular expression to test against, or a function that will be called with the value to test, and must return a boolean. By default everything will be included.exclude: The same asinclude, but matching values will be excluded instead.
Example
The source code repository for this plugin is setup as a Next.js project.
To try it yourself, simply clone, install, and run this project:
git clone https://github.com/remcohaszing/recma-nextjs-static-props.git
cd recma-nextjs-static-props
npm ci
npm run dev
Related Projects
This plugin works well with the following MDX plugins:
17 Dec 4, 2022
2 Jun 23, 2022
2 Jan 8, 2022
4 Apr 27, 2022
17 Nov 23, 2022
6 Nov 9, 2022
7 Jun 27, 2022
33 Dec 27, 2022
200 Jan 3, 2023
2 Jun 12, 2022