@readme/markdown 9.1.0 → 9.1.2

package/dist/contexts/index.d.ts

@@ -1,5 +1,5 @@
-import type { RMDXModuleProps, RunOpts } from '../lib/run';
+import type { RunOpts } from '../lib/run';
 import React from 'react';
-type Props = Pick<RMDXModuleProps, 'theme'> & Pick<RunOpts, 'baseUrl' | 'terms' | 'variables'> & React.PropsWithChildren;
+type Props = Pick<RunOpts, 'baseUrl' | 'terms' | 'theme' | 'variables'> & React.PropsWithChildren;
 declare const Contexts: ({ children, terms, variables, baseUrl, theme }: Props) => React.ReactNode;
 export default Contexts;

package/dist/lib/ast-processor.d.ts

@@ -4,6 +4,7 @@ import remarkFrontmatter from 'remark-frontmatter';
 import remarkGfm from 'remark-gfm';
 export interface MdastOpts {
     components?: Record<string, string>;
+    missingComponents?: 'ignore' | 'throw';
     remarkPlugins?: PluggableList;
 }
 export declare const remarkPlugins: ((() => (tree: import("mdast").Root) => void) | (({ copyButtons }?: {

package/dist/lib/compile.d.ts

@@ -2,7 +2,8 @@ import type { CompileOptions } from '@mdx-js/mdx';
 export type CompileOpts = CompileOptions & {
     components?: Record<string, string>;
     copyButtons?: boolean;
+    missingComponents?: 'ignore' | 'throw';
     useTailwind?: boolean;
 };
-declare const compile: (text: string, { components, copyButtons, useTailwind, ...opts }?: CompileOpts) => Promise<string>;
+declare const compile: (text: string, { components, missingComponents, copyButtons, useTailwind, ...opts }?: CompileOpts) => Promise<string>;
 export default compile;

package/dist/lib/run.d.ts

@@ -2,16 +2,13 @@ import type { GlossaryTerm } from '../contexts/GlossaryTerms';
 import type { CustomComponents, RMDXModule } from '../types';
 import type { Variables } from '../utils/user';
 import type { RunOptions } from '@mdx-js/mdx';
-import type { MDXProps } from 'mdx/types';
 export type RunOpts = Omit<RunOptions, 'Fragment'> & {
     baseUrl?: string;
     components?: CustomComponents;
     imports?: Record<string, unknown>;
     terms?: GlossaryTerm[];
+    theme?: 'dark' | 'light';
     variables?: Variables;
 };
-export type RMDXModuleProps = MDXProps & {
-    theme: 'dark' | 'light';
-};
 declare const run: (string: string, _opts?: RunOpts) => Promise<RMDXModule>;
 export default run;

package/dist/lib/utils/makeUseMdxComponents.d.ts

@@ -0,0 +1,3 @@
+import type { UseMdxComponents } from '@mdx-js/mdx';
+declare const makeUseMDXComponents: (more?: ReturnType<UseMdxComponents>) => UseMdxComponents;
+export default makeUseMDXComponents;

package/dist/main.js

@@ -70614,6 +70614,28 @@ const getExports = (tree) => {
     return Array.from(set);
 };
 
+;// ./processor/transform/handle-missing-components.ts
+
+
+
+const handleMissingComponents = ({ components, missingComponents }) => tree => {
+    const allComponents = new Set([
+        ...getExports(tree),
+        ...Object.keys(components_namespaceObject),
+        ...Object.keys(components),
+        'Variable',
+    ]);
+    visit(tree, isMDXElement, (node, index, parent) => {
+        if (allComponents.has(node.name) || node.name.match(/^[a-z]/))
+            return;
+        if (missingComponents === 'throw') {
+            throw new Error(`Expected component \`${node.name}\` to be defined: you likely forgot to import, pass, or provide it.`);
+        }
+        parent.children.splice(index, 1);
+    }, true);
+};
+/* harmony default export */ const handle_missing_components = (handleMissingComponents);
+
 ;// ./processor/transform/images.ts
 
 
@@ -71017,7 +71039,6 @@ const readmeToMdx = () => tree => {
                 },
             },
         };
-        // @ts-expect-error -- I have no idea why our mdast types don't always work
         parent.children.splice(index, 1, mdxFlowExpression);
     });
     return tree;
@@ -71236,6 +71257,7 @@ const variables = ({ asMdx } = { asMdx: true }) => tree => {
 
 
 
+
 const defaultTransforms = {
     calloutTransformer: callouts,
     codeTabsTransformer: code_tabs,
@@ -71254,12 +71276,22 @@ const defaultTransforms = {
 
 const remarkPlugins = [remarkFrontmatter, remarkGfm, ...transform];
 const rehypePlugins = [rehypeSlug, transform_mermaid];
-const astProcessor = (opts = { components: {} }) => remark()
-    .use(remarkMdx)
-    .use(remarkPlugins)
-    .use(opts.remarkPlugins)
-    .use(transform_variables, { asMdx: false })
-    .use(readme_components({ components: opts.components }));
+const astProcessor = (opts = {}) => {
+    const components = opts.components || {};
+    let processor = remark()
+        .use(remarkMdx)
+        .use(remarkPlugins)
+        .use(opts.remarkPlugins)
+        .use(transform_variables, { asMdx: false })
+        .use(readme_components({ components }));
+    if (['ignore', 'throw'].includes(opts.missingComponents)) {
+        processor = processor.use(handle_missing_components, {
+            components,
+            missingComponents: opts.missingComponents,
+        });
+    }
+    return processor;
+};
 /* harmony default export */ const ast_processor = (astProcessor);
 
 ;// ./node_modules/markdown-extensions/index.js
@@ -83810,12 +83842,16 @@ const tocHastToMdx = (toc, components) => {
 
 
 const { codeTabsTransformer: compile_codeTabsTransformer, ...transforms } = defaultTransforms;
-const compile_compile = async (text, { components = {}, copyButtons, useTailwind, ...opts } = {}) => {
+const compile_compile = async (text, { components = {}, missingComponents, copyButtons, useTailwind, ...opts } = {}) => {
     const remarkPlugins = [
         remarkFrontmatter,
         remarkGfm,
         ...Object.values(transforms),
         [compile_codeTabsTransformer, { copyButtons }],
+        [
+            handle_missing_components,
+            { components, missingComponents: ['ignore', 'throw'].includes(missingComponents) ? missingComponents : 'ignore' },
+        ],
     ];
     if (useTailwind) {
         remarkPlugins.push([transform_tailwind, { components }]);
@@ -99168,12 +99204,12 @@ function runSync(code, options) {
   return new Function(String(code))(options)
 }
 
-// EXTERNAL MODULE: external "@readme/variable"
-var variable_ = __webpack_require__(8167);
-var variable_default = /*#__PURE__*/__webpack_require__.n(variable_);
 // EXTERNAL MODULE: ./node_modules/react/jsx-runtime.js
 var jsx_runtime = __webpack_require__(4848);
 var jsx_runtime_namespaceObject = /*#__PURE__*/__webpack_require__.t(jsx_runtime, 2);
+// EXTERNAL MODULE: external "@readme/variable"
+var variable_ = __webpack_require__(8167);
+var variable_default = /*#__PURE__*/__webpack_require__.n(variable_);
 ;// ./contexts/index.tsx
 
 
@@ -99208,14 +99244,7 @@ const User = (variables) => {
 };
 /* harmony default export */ const user = (User);
 
-;// ./lib/run.tsx
-
-
-
-
-
-
-
+;// ./lib/utils/makeUseMdxComponents.ts
 
 
 const makeUseMDXComponents = (more = {}) => {
@@ -99238,12 +99267,23 @@ const makeUseMDXComponents = (more = {}) => {
         ...headings,
         ...more,
     };
-    // @ts-expect-error I'm not sure how to coerce the correct type
-    return () => components;
+    return (() => components);
 };
+/* harmony default export */ const makeUseMdxComponents = (makeUseMDXComponents);
+
+;// ./lib/run.tsx
+
+
+
+
+
+
+
+
+
 const run_run = async (string, _opts = {}) => {
     const { Fragment } = jsx_runtime_namespaceObject;
-    const { components = {}, terms, variables, baseUrl, imports = {}, ...opts } = _opts;
+    const { components = {}, terms, variables, baseUrl, imports = {}, theme, ...opts } = _opts;
     const tocsByTag = {};
     const exportedComponents = Object.entries(components).reduce((memo, [tag, mod]) => {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -99257,7 +99297,7 @@ const run_run = async (string, _opts = {}) => {
         }
         return memo;
     }, {});
-    const exec = (text, { useMDXComponents = makeUseMDXComponents(exportedComponents) } = {}) => {
+    const exec = (text, { useMDXComponents = makeUseMdxComponents(exportedComponents) } = {}) => {
         return run(text, {
             ...jsx_runtime_namespaceObject,
             Fragment,
@@ -99277,7 +99317,7 @@ const run_run = async (string, _opts = {}) => {
         Toc = tocModule.default;
     }
     return {
-        default: (props) => (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(contexts, { baseUrl: baseUrl, terms: terms, theme: props.theme, variables: variables },
+        default: (props) => (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(contexts, { baseUrl: baseUrl, terms: terms, theme: theme, variables: variables },
             external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(Content, { ...props }))),
         toc,
         Toc: props => Toc ? (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(components_TableOfContents, null,

package/dist/main.node.js

@@ -75206,6 +75206,28 @@ const getExports = (tree) => {
     return Array.from(set);
 };
 
+;// ./processor/transform/handle-missing-components.ts
+
+
+
+const handleMissingComponents = ({ components, missingComponents }) => tree => {
+    const allComponents = new Set([
+        ...getExports(tree),
+        ...Object.keys(components_namespaceObject),
+        ...Object.keys(components),
+        'Variable',
+    ]);
+    visit(tree, isMDXElement, (node, index, parent) => {
+        if (allComponents.has(node.name) || node.name.match(/^[a-z]/))
+            return;
+        if (missingComponents === 'throw') {
+            throw new Error(`Expected component \`${node.name}\` to be defined: you likely forgot to import, pass, or provide it.`);
+        }
+        parent.children.splice(index, 1);
+    }, true);
+};
+/* harmony default export */ const handle_missing_components = (handleMissingComponents);
+
 ;// ./processor/transform/images.ts
 
 
@@ -75609,7 +75631,6 @@ const readmeToMdx = () => tree => {
                 },
             },
         };
-        // @ts-expect-error -- I have no idea why our mdast types don't always work
         parent.children.splice(index, 1, mdxFlowExpression);
     });
     return tree;
@@ -75828,6 +75849,7 @@ const variables = ({ asMdx } = { asMdx: true }) => tree => {
 
 
 
+
 const defaultTransforms = {
     calloutTransformer: callouts,
     codeTabsTransformer: code_tabs,
@@ -75846,12 +75868,22 @@ const defaultTransforms = {
 
 const remarkPlugins = [remarkFrontmatter, remarkGfm, ...transform];
 const rehypePlugins = [rehypeSlug, transform_mermaid];
-const astProcessor = (opts = { components: {} }) => remark()
-    .use(remarkMdx)
-    .use(remarkPlugins)
-    .use(opts.remarkPlugins)
-    .use(transform_variables, { asMdx: false })
-    .use(readme_components({ components: opts.components }));
+const astProcessor = (opts = {}) => {
+    const components = opts.components || {};
+    let processor = remark()
+        .use(remarkMdx)
+        .use(remarkPlugins)
+        .use(opts.remarkPlugins)
+        .use(transform_variables, { asMdx: false })
+        .use(readme_components({ components }));
+    if (['ignore', 'throw'].includes(opts.missingComponents)) {
+        processor = processor.use(handle_missing_components, {
+            components,
+            missingComponents: opts.missingComponents,
+        });
+    }
+    return processor;
+};
 /* harmony default export */ const ast_processor = (astProcessor);
 
 ;// ./node_modules/markdown-extensions/index.js
@@ -88402,12 +88434,16 @@ const tocHastToMdx = (toc, components) => {
 
 
 const { codeTabsTransformer: compile_codeTabsTransformer, ...transforms } = defaultTransforms;
-const compile_compile = async (text, { components = {}, copyButtons, useTailwind, ...opts } = {}) => {
+const compile_compile = async (text, { components = {}, missingComponents, copyButtons, useTailwind, ...opts } = {}) => {
     const remarkPlugins = [
         remarkFrontmatter,
         remarkGfm,
         ...Object.values(transforms),
         [compile_codeTabsTransformer, { copyButtons }],
+        [
+            handle_missing_components,
+            { components, missingComponents: ['ignore', 'throw'].includes(missingComponents) ? missingComponents : 'ignore' },
+        ],
     ];
     if (useTailwind) {
         remarkPlugins.push([transform_tailwind, { components }]);
@@ -103760,12 +103796,12 @@ function runSync(code, options) {
   return new Function(String(code))(options)
 }
 
-// EXTERNAL MODULE: ./node_modules/@readme/variable/dist/index.js
-var dist = __webpack_require__(4355);
-var dist_default = /*#__PURE__*/__webpack_require__.n(dist);
 // EXTERNAL MODULE: ./node_modules/react/jsx-runtime.js
 var jsx_runtime = __webpack_require__(4848);
 var jsx_runtime_namespaceObject = /*#__PURE__*/__webpack_require__.t(jsx_runtime, 2);
+// EXTERNAL MODULE: ./node_modules/@readme/variable/dist/index.js
+var dist = __webpack_require__(4355);
+var dist_default = /*#__PURE__*/__webpack_require__.n(dist);
 ;// ./contexts/index.tsx
 
 
@@ -103800,14 +103836,7 @@ const User = (variables) => {
 };
 /* harmony default export */ const user = (User);
 
-;// ./lib/run.tsx
-
-
-
-
-
-
-
+;// ./lib/utils/makeUseMdxComponents.ts
 
 
 const makeUseMDXComponents = (more = {}) => {
@@ -103830,12 +103859,23 @@ const makeUseMDXComponents = (more = {}) => {
         ...headings,
         ...more,
     };
-    // @ts-expect-error I'm not sure how to coerce the correct type
-    return () => components;
+    return (() => components);
 };
+/* harmony default export */ const makeUseMdxComponents = (makeUseMDXComponents);
+
+;// ./lib/run.tsx
+
+
+
+
+
+
+
+
+
 const run_run = async (string, _opts = {}) => {
     const { Fragment } = jsx_runtime_namespaceObject;
-    const { components = {}, terms, variables, baseUrl, imports = {}, ...opts } = _opts;
+    const { components = {}, terms, variables, baseUrl, imports = {}, theme, ...opts } = _opts;
     const tocsByTag = {};
     const exportedComponents = Object.entries(components).reduce((memo, [tag, mod]) => {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -103849,7 +103889,7 @@ const run_run = async (string, _opts = {}) => {
         }
         return memo;
     }, {});
-    const exec = (text, { useMDXComponents = makeUseMDXComponents(exportedComponents) } = {}) => {
+    const exec = (text, { useMDXComponents = makeUseMdxComponents(exportedComponents) } = {}) => {
         return run(text, {
             ...jsx_runtime_namespaceObject,
             Fragment,
@@ -103869,7 +103909,7 @@ const run_run = async (string, _opts = {}) => {
         Toc = tocModule.default;
     }
     return {
-        default: (props) => (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(contexts, { baseUrl: baseUrl, terms: terms, theme: props.theme, variables: variables },
+        default: (props) => (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(contexts, { baseUrl: baseUrl, terms: terms, theme: theme, variables: variables },
             external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(Content, { ...props }))),
         toc,
         Toc: props => Toc ? (external_amd_react_commonjs_react_commonjs2_react_root_React_umd_react_default().createElement(components_TableOfContents, null,