Initial commit

Author: remcohaszing

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 100
+trim_trailing_whitespace = true
+
+[COMMIT_EDITMSG]
+max_line_length = 72

.eslintignore

@@ -0,0 +1 @@
+*.jsx

.eslintrc.yaml

@@ -0,0 +1,5 @@
+root: true
+extends:
+  - remcohaszing
+rules:
+  import/no-extraneous-dependencies: off

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+on:
+  - pull_request
+  - push
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: ESLint
+        run: |
+          yarn --frozen-lockfile
+          yarn eslint .
+
+  jest:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [12, 14]
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Test
+        run: |
+          yarn --frozen-lockfile
+          yarn test
+
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: Prettier
+        run: |
+          yarn --frozen-lockfile
+          yarn prettier .
+
+  tsc:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+      - name: TypeScript
+        run: |
+          yarn --frozen-lockfile
+          yarn tsc

.gitignore

@@ -0,0 +1,5 @@
+coverage/
+dist/
+node_modules/
+*.log
+*.tgz

.prettierignore

@@ -0,0 +1,4 @@
+coverage/
+dist/
+node_modules/
+*.jsx

.prettierrc.yaml

@@ -0,0 +1,3 @@
+proseWrap: always
+singleQuote: true
+trailingComma: all

LICENSE.md

@@ -0,0 +1,18 @@
+# MIT License
+
+Copyright © 2021 Remco Haszing
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute,
+sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,74 @@
+# remark-mdx-frontmatter
+
+[![github actions][github actions badge]][github actions] [![codecov][codecov badge]][codecov]
+[![npm][npm badge]][npm] [![prettier][prettier badge]][prettier]
+
+> A [remark][] plugin for converting frontmatter metadata into MDX exports
+
+## Installation
+
+This package depends on the AST output by [remark-frontmatter][]
+
+```sh
+npm install remark-frontmatter remark-mdx-frontmatter
+```
+
+## Usage
+
+This remark plugin takes frontmatter content, and outputs it as JavaScript exports. Both YAML and
+TOML frontmatter data are supported.
+
+For example, given a file named `example.mdx` with the following contents:
+
+```mdx
+---
+hello: frontmatter
+---
+
+Rest of document
+```
+
+The following script:
+
+```js
+import { readFileSync } from 'fs';
+
+import remarkFrontmatter from 'remark-frontmatter';
+import { remarkMdxFrontmatter } from 'remark-mdx-frontmatter';
+import { compileSync } from 'xdm';
+
+const { contents } = compileSync(readFileSync('example.mdx'), {
+  jsx: true,
+  remarkPlugins: [remarkFrontmatter, remarkMdxFrontmatter],
+});
+console.log(contents);
+```
+
+Roughly yields:
+
+```jsx
+export const hello = 'frontmatter';
+
+export default function MDXContent() {
+  return <p>Rest of document</p>;
+}
+```
+
+### Options
+
+#### `name`
+
+By default, every frontmatter object key is turned into a JavaScript export. If `name` is specified,
+the YAML content is exported as one single export using this name. This is useful if you wish to use
+top-level frontmatter nodes other than objects, or if the frontmatter content contains keys which
+aren’t valid JavaScript identifiers.
+
+[github actions badge]:
+  https://github.com/remcohaszing/remark-mdx-frontmatter/workflows/ci/badge.svg
+[github actions]: https://github.com/remcohaszing/remark-mdx-frontmatter/actions
+[npm badge]: https://img.shields.io/npm/v/remark-mdx-frontmatter
+[npm]: https://www.npmjs.com/package/remark-mdx-frontmatter
+[prettier badge]: https://img.shields.io/badge/code_style-prettier-ff69b4.svg
+[prettier]: https://prettier.io
+[remark]: https://remark.js.org
+[remark-frontmatter]: https://github.com/remarkjs/remark-frontmatter

__fixtures__/default/expected.jsx

@@ -0,0 +1,22 @@
+/*@jsxRuntime automatic @jsxImportSource react*/
+export const title = "Hello frontmatter", index = 1, nested = {
+  "data": {
+    "structure": {
+      "including": {
+        "numbers": 42,
+        "booleans": true,
+        "null": null,
+        "dates": new Date(1444435200000),
+        "datetimes": new Date(1444471200000),
+        "timezones": new Date(1444438800000),
+        "arrays": ["of", "items"]
+      }
+    }
+  }
+};
+function MDXContent(_props) {
+  const _components = Object.assign({}, _props.components), {wrapper: MDXLayout} = _components;
+  const _content = <></>;
+  return MDXLayout ? <MDXLayout {..._props}>{_content}</MDXLayout> : _content;
+}
+export default MDXContent;