feat: doc support Sandpack component

web-infra-dev · Aug 30, 2023 · c552877 · c552877
1 parent 33a2b1a
commit c552877
Show file tree

Hide file tree

Showing 8 changed files with 478 additions and 144 deletions.
diff --git a/packages/document/main-doc/package.json b/packages/document/main-doc/package.json
@@ -27,6 +27,9 @@
     "access": "public",
     "provenance": true
   },
+  "dependencies": {
+    "@modern-js/sandpack-react": "workspace:*"
+  },
   "peerDependencies": {
     "@modern-js/builder-doc": "workspace:^2.32.1"
   },

diff --git a/packages/document/main-doc/src/components/Sandpack/index.css b/packages/document/main-doc/src/components/Sandpack/index.css
@@ -0,0 +1,7 @@
+.light {
+  --sp-layout-height: 500px !important;
+}
+
+.dark {
+  --sp-layout-height: 500px !important;
+}
diff --git a/packages/document/main-doc/src/components/Sandpack/index.tsx b/packages/document/main-doc/src/components/Sandpack/index.tsx
@@ -0,0 +1,28 @@
+import ModernSandpack, { ModernSandpackProps } from '@modern-js/sandpack-react';
+import React, { PropsWithChildren } from 'react';
+import { useDark } from 'rspress/runtime';
+
+import './index.css';
+
+const Sandpack = (props: PropsWithChildren<ModernSandpackProps>) => {
+  const dark = useDark();
+  const { children, ...otherProps } = props;
+  const files: Record<string, string> = {};
+  React.Children.forEach(children, (child: any) => {
+    if (child) {
+      const { meta, children } = child.props.children.props;
+      const matches = meta.match(/title="(.*)"/);
+      if (matches.length > 1) {
+        files[matches[1]] = children;
+      }
+    }
+  });
+  return (
+    <ModernSandpack
+      files={files}
+      theme={dark ? 'dark' : 'light'}
+      {...otherProps}
+    />
+  );
+};
+export default Sandpack;
diff --git a/packages/generator/generators/mwa-generator/src/index.ts b/packages/generator/generators/mwa-generator/src/index.ts
@@ -145,7 +145,7 @@ export const handleTemplateFile = async (
       isMonorepoSubProject,
       modernVersion,
       packageManager,
-      isTsProject: language === Language.TS,
+      isTs: language === Language.TS,
     },
   );
 

diff --git a/packages/generator/generators/mwa-generator/templates/base-template/package.json.handlebars b/packages/generator/generators/mwa-generator/templates/base-template/package.json.handlebars
@@ -41,7 +41,7 @@
     "@modern-js/eslint-config": "{{modernVersion}}",
     "@modern-js/tsconfig":"{{modernVersion}}",
     "@modern-js-app/eslint-config": "{{modernVersion}}",
-    {{#if isTsProject}}
+    {{#if isTs}}
     "typescript": "~5.0.4",
     "@types/jest": "~29.2.4",
     "@types/node": "~16.11.7",

diff --git a/packages/generator/sandpack-react/scripts/template.ts b/packages/generator/sandpack-react/scripts/template.ts
@@ -5,6 +5,18 @@ import { renderString } from '@modern-js/codesmith-api-handlebars';
 import { getModernVersion } from '@modern-js/generator-utils';
 import { Solution } from '@modern-js/generator-common';
 
+const IgnoreFiles = [
+  '.nvmrc',
+  '.eslintrc.js.handlebars',
+  'src/.eslintrc.js.handlebars',
+  '.prettierrc',
+  '.vscode/extensions.json',
+  '.vscode/settings.json',
+  '.husky/pre-commit',
+  'README.md',
+  '.gitignore.handlebars',
+];
+
 async function handleTemplate(
   templatePath: string,
   data: Record<string, any> = {},
@@ -17,6 +29,9 @@ async function handleTemplate(
   const templateFiles = await recursive(templatePath);
   templateFiles.forEach(filePath => {
     const file = filePath.replace(`${templatePath}/`, '');
+    if (IgnoreFiles.includes(file)) {
+      return;
+    }
     if (fs.statSync(filePath).isFile()) {
       if (file.endsWith('.handlebars')) {
         files[

diff --git a/packages/generator/sandpack-react/src/index.tsx b/packages/generator/sandpack-react/src/index.tsx
@@ -6,16 +6,18 @@ import {
   OpenInCodeSandboxButton,
   SandpackSetup,
   SandpackFiles,
+  SandpackThemeProp,
 } from '@codesandbox/sandpack-react';
 import { ModernTemplates } from './templates';
 
 export type ModernSandpackProps = {
   template: 'web-app' | 'npm-module';
   customSetup?: SandpackSetup;
   files?: SandpackFiles;
-  removeFiles: string[];
+  removeFiles?: string[];
   options?: Record<string, any>;
   initialCollapsedFolder?: string[];
+  theme?: SandpackThemeProp;
 };
 
 function fileterFiles(files: SandpackFiles, removeFiles: string[]) {
@@ -39,6 +41,7 @@ export default function ModernSandpack(props: ModernSandpackProps) {
     removeFiles = [],
     options = {},
     initialCollapsedFolder = [],
+    theme = 'light',
   } = props;
   const initFiles = ModernTemplates[template];
   const files = {
@@ -47,6 +50,7 @@ export default function ModernSandpack(props: ModernSandpackProps) {
   };
   return (
     <SandpackProvider
+      theme={theme}
       customSetup={{ environment: 'node', ...customSetup }}
       files={files}
       options={{
@@ -69,7 +73,7 @@ export default function ModernSandpack(props: ModernSandpackProps) {
           ]}
         />
         <SandpackCodeEditor showLineNumbers showInlineErrors showTabs={false} />
-        <div style={{ position: 'absolute', right: 0, bottom: 0 }}>
+        <div style={{ position: 'absolute', right: '5px', bottom: '5px' }}>
           <OpenInCodeSandboxButton />
         </div>
       </SandpackLayout>