chore(cleanup): move mdx files out of root

Author: avivkeller

apps/site/components/Downloads/Release/ReleaseCodeBox.tsx

@@ -11,21 +11,21 @@ import CodeBox from '#site/components/Common/CodeBox';
 import LinkWithArrow from '#site/components/Common/LinkWithArrow';
 import Link from '#site/components/Link';
 import WithReleaseAlertBox from '#site/components/withReleaseAlertBox';
-import { createSval } from '#site/next.jsx.compiler.mjs';
 import {
   ReleaseContext,
   ReleasesContext,
 } from '#site/providers/releaseProvider';
 import type { DownloadSnippet } from '#site/types/download';
 import type { ReleaseContextType } from '#site/types/release';
 import { INSTALL_METHODS } from '#site/util/download';
+import { createEvaluator } from '#site/util/evaluator';
 
 // Creates a minimal JavaScript interpreter for parsing the JavaScript code from the snippets
 // Note: that the code runs inside a sandboxed environment and cannot interact with any code outside of the sandbox
 // It also does not have access to any Global or Window objects, nor it can execute code on the end-user's browser
 // It also only allows a return statement for a string and it forces the return value to also be a string and only be used
 // by Shiki to render the highlighted syntax. Hence XSS attacks or JavaScript injections are not possible.
-const interpreter = createSval({}, 'script');
+const interpreter = createEvaluator({}, 'script');
 
 /**
  * Parses a snippet string using the interpreter with the given release context

apps/site/next.mdx.compiler.mjs apps/site/mdx/compiler.mjsapps/site/next.mdx.compiler.mjs renamed to apps/site/mdx/compiler.mjs

@@ -4,12 +4,12 @@ import { compile as mdxCompile } from '@mdx-js/mdx';
 import { Fragment, jsx, jsxs } from 'react/jsx-runtime';
 import { matter } from 'vfile-matter';
 
-import { createSval } from './next.jsx.compiler.mjs';
-import { REHYPE_PLUGINS, REMARK_PLUGINS } from './next.mdx.plugins.mjs';
-import { createGitHubSlugger } from './util/github';
+import { rehypePlugins, remarkPlugins } from './plugins.mjs';
+import { createEvaluator } from '../util/evaluator';
+import { createGitHubSlugger } from '../util/github';
 
 // Defines a JSX Fragment and JSX Runtime for the MDX Compiler
-export const reactRuntime = { Fragment, jsx, jsxs };
+const reactRuntime = { Fragment, jsx, jsxs };
 
 /**
  * This is our custom simple MDX Compiler that is used to compile Markdown and MDX
@@ -27,7 +27,7 @@ export const reactRuntime = { Fragment, jsx, jsxs };
  *   readingTime: import('reading-time').ReadTimeResults;
  * }>}
  */
-export async function compile(
+export default async function compile(
   source,
   fileExtension,
   components = {},
@@ -42,12 +42,12 @@ export async function compile(
 
   // Compiles the MDX/Markdown source into a serializable VFile
   const compiled = await mdxCompile(source, {
-    rehypePlugins: REHYPE_PLUGINS,
-    remarkPlugins: REMARK_PLUGINS,
+    rehypePlugins,
+    remarkPlugins,
     format: fileExtension,
   });
 
-  const interpreter = createSval({
+  const interpreter = createEvaluator({
     ...components,
     'react/jsx-runtime': reactRuntime,
   });

apps/site/mdx/components.mjs

@@ -0,0 +1,87 @@
+'use strict';
+
+import BadgeGroup from '@node-core/ui-components/Common/BadgeGroup';
+import Blockquote from '@node-core/ui-components/Common/Blockquote';
+import MDXCodeTabs from '@node-core/ui-components/MDX/CodeTabs';
+
+import Button from '../components/Common/Button';
+import LinkWithArrow from '../components/Common/LinkWithArrow';
+import DownloadButton from '../components/Downloads/DownloadButton';
+import DownloadsTable from '../components/Downloads/DownloadsTable';
+import BlogPostLink from '../components/Downloads/Release/BlogPostLink';
+import ChangelogLink from '../components/Downloads/Release/ChangelogLink';
+import ReleaseDownloadLink from '../components/Downloads/Release/DownloadLink';
+import ReleaseInstallationMethodDropdown from '../components/Downloads/Release/InstallationMethodDropdown';
+import ReleaseOperatingSystemDropdown from '../components/Downloads/Release/OperatingSystemDropdown';
+import ReleasePackageManagerDropdown from '../components/Downloads/Release/PackageManagerDropdown';
+import ReleasePlatformDropdown from '../components/Downloads/Release/PlatformDropdown';
+import ReleasePrebuiltDownloadButtons from '../components/Downloads/Release/PrebuiltDownloadButtons';
+import ReleaseCodeBox from '../components/Downloads/Release/ReleaseCodeBox';
+import ReleaseVersionDropdown from '../components/Downloads/Release/VersionDropdown';
+import EOLAlertBox from '../components/EOL/EOLAlert';
+import EOLReleaseTable from '../components/EOL/EOLReleaseTable';
+import Link from '../components/Link';
+import UpcomingMeetings from '../components/MDX/Calendar/UpcomingMeetings';
+import MDXCodeBox from '../components/MDX/CodeBox';
+import MDXImage from '../components/MDX/Image';
+import MinorReleasesTable from '../components/Releases/MinorReleasesTable';
+import PreviousReleasesTable from '../components/Releases/PreviousReleasesTable';
+import ReleaseOverview from '../components/Releases/ReleaseOverview';
+import WithBadgeGroup from '../components/withBadgeGroup';
+import WithBanner from '../components/withBanner';
+import WithDownloadArchive from '../components/withDownloadArchive';
+import WithNodeRelease from '../components/withNodeRelease';
+import WithReleaseAlertBox from '../components/withReleaseAlertBox';
+import WithReleaseSelect from '../components/withReleaseSelect';
+import { ReleaseProvider } from '../providers/releaseProvider';
+
+/**
+ * A full list of React Components that we want to pass through to MDX
+ *
+ * @satisfies {import('mdx/types').MDXComponents}
+ */
+export default {
+  // HTML overrides
+  a: Link,
+  blockquote: Blockquote,
+  pre: MDXCodeBox,
+  img: MDXImage,
+  // Renders MDX CodeTabs
+  CodeTabs: MDXCodeTabs,
+  // Renders a Download Button
+  DownloadButton,
+  // Renders a stateless Release Select Component
+  WithReleaseSelect,
+  // Group of components that enable you to select versions for Node.js
+  // releases and download selected versions. Uses `releaseProvider` as a provider
+  Release: {
+    Provider: ReleaseProvider,
+    VersionDropdown: ReleaseVersionDropdown,
+    InstallationMethodDropdown: ReleaseInstallationMethodDropdown,
+    PackageManagerDropdown: ReleasePackageManagerDropdown,
+    PlatformDropdown: ReleasePlatformDropdown,
+    OperatingSystemDropdown: ReleaseOperatingSystemDropdown,
+    BlogPostLink,
+    PrebuiltDownloadButtons: ReleasePrebuiltDownloadButtons,
+    ReleaseCodeBox,
+    ChangelogLink,
+    DownloadLink: ReleaseDownloadLink,
+  },
+  // HOC for providing the Download Archive Page properties
+  WithDownloadArchive,
+  DownloadsTable,
+  PreviousReleasesTable,
+  WithNodeRelease,
+  WithReleaseAlertBox,
+  WithBanner,
+  WithBadgeGroup,
+  BadgeGroup,
+  ReleaseOverview,
+  MinorReleasesTable,
+  UpcomingMeetings,
+  EOLAlertBox,
+  EOLReleaseTable,
+  Button,
+  Link,
+  LinkWithArrow,
+};

apps/site/next.mdx.plugins.mjs apps/site/mdx/plugins.mjsapps/site/next.mdx.plugins.mjs renamed to apps/site/mdx/plugins.mjs

@@ -10,7 +10,7 @@ import readingTime from 'remark-reading-time';
 /**
  * Provides all our Rehype Plugins that are used within MDX
  */
-export const REHYPE_PLUGINS = [
+export const rehypePlugins = [
   // Generates `id` attributes for headings (H1, ...)
   rehypeSlug,
   // Automatically add anchor links to headings (H1, ...)
@@ -23,7 +23,7 @@ export const REHYPE_PLUGINS = [
 /**
  * Provides all our Remark Plugins that are used within MDX
  */
-export const REMARK_PLUGINS = [
+export const remarkPlugins = [
   // Support GFM syntax to be used within Markdown
   remarkGfm,
   // Generates metadata regarding headings

apps/site/next.dynamic.mjs

@@ -7,6 +7,8 @@ import matter from 'gray-matter';
 import { cache } from 'react';
 import { VFile } from 'vfile';
 
+import compile from './mdx/compiler.mjs';
+import mdxComponents from './mdx/components.mjs';
 import { BASE_PATH } from './next.constants.mjs';
 import { BASE_URL } from './next.constants.mjs';
 import { DEFAULT_CATEGORY_OG_TYPE } from './next.constants.mjs';
@@ -16,8 +18,6 @@ import { PAGE_METADATA } from './next.dynamic.constants.mjs';
 import { getMarkdownFiles } from './next.helpers.mjs';
 import { siteConfig } from './next.json.mjs';
 import { availableLocaleCodes, defaultLocale } from './next.locales.mjs';
-import { compile } from './next.mdx.compiler.mjs';
-import { MDX_COMPONENTS } from './next.mdx.components.mjs';
 
 // This is the combination of the Application Base URL and Base PATH
 const baseUrlAndPath = `${BASE_URL}${BASE_PATH}`;
@@ -177,7 +177,7 @@ const getDynamicRouter = async () => {
 
     // This compiles our MDX source (VFile) into a final MDX-parsed VFile
     // that then is passed as a string to the MDXProvider which will run the MDX Code
-    return compile(sourceAsVirtualFile, fileExtension, MDX_COMPONENTS);
+    return compile(sourceAsVirtualFile, fileExtension, mdxComponents);
   };
 
   // Creates a Cached Version of the MDX Compiler

apps/site/next.jsx.compiler.mjs

@@ -0,0 +1,18 @@
+'use strict';
+
+import Sval from 'sval';
+
+export const createEvaluator = (
+  dependencies: Record<string, unknown> = {},
+  mode: 'module' | 'script' = 'module'
+) => {
+  const svalInterpreter = new Sval({
+    ecmaVer: 'latest',
+    sandBox: true,
+    sourceType: mode,
+  });
+
+  svalInterpreter.import(dependencies);
+
+  return svalInterpreter;
+};