create-zephyr-apps 0.0.8 → 0.0.39

package/package/index.ts

@@ -1,255 +0,0 @@
-#!/usr/bin/env node
-import { exec } from 'node:child_process';
-import * as fs from 'node:fs';
-import path from 'node:path';
-import { setTimeout } from 'node:timers/promises';
-import {
-  cancel,
-  confirm,
-  group,
-  intro,
-  isCancel,
-  note,
-  select,
-  spinner,
-  text,
-  updateSettings,
-} from '@clack/prompts';
-import c from 'chalk';
-import * as tempy from 'tempy';
-import { TEMPLATES } from './utils/constants';
-import end_note from './utils/end';
-import type { CLIOptions } from './utils/types';
-
-/**
- * Helper function to execute a command in the given working directory.
- */
-function runCmd(cmd: string, cwd: string): Promise<void> {
-  return new Promise((resolve, reject) => {
-    exec(cmd, { cwd }, (err, stdout, stderr) => {
-      if (err) {
-        console.error(`Error executing command: ${cmd}`, err);
-        reject(err);
-      } else {
-        resolve();
-      }
-    });
-  });
-}
-
-/**
- * Initialize Git in the project directory, set temporary user configuration,
- * commit the changes, and then remove the local configuration.
- */
-async function initializeGit(projectPath: string): Promise<void> {
-  // Ask the user if they want to initialize a Git repository.
-  const shouldInit = await confirm({
-    message: 'Would you like to initialize a new Git repository?',
-    initialValue: true,
-  });
-
-  if (isCancel(shouldInit)) {
-    cancel('Operation cancelled');
-    process.exit(0);
-  }
-
-  if (shouldInit) {
-    // Initialize the repository.
-    await runCmd('git init', projectPath);
-
-    // Set temporary Git user configuration.
-    await runCmd(
-      'git config user.email "zephyrbot@zephyr-cloud.io"',
-      projectPath,
-    );
-    await runCmd('git config user.name "Zephyr Bot"', projectPath);
-
-    // Stage all files and commit them.
-    await runCmd('git add .', projectPath);
-    await runCmd('git commit -m "Initial commit from Zephyr"', projectPath);
-
-    // Remove the temporary local Git configuration so that the user's global
-    // settings will be used for future commits.
-    await runCmd('git config --unset user.email', projectPath);
-    await runCmd('git config --unset user.name', projectPath);
-  }
-}
-
-async function main() {
-  console.clear();
-
-  await setTimeout(1000);
-
-  updateSettings({
-    aliases: {
-      w: 'up',
-      s: 'down',
-      a: 'left',
-      d: 'right',
-    },
-  });
-
-  note('npx create-zephyr-apps@latest');
-  intro(`${c.bgCyan(c.black(' Create federated applications with Zephyr '))}`);
-
-  const project = (await group(
-    {
-      path: ({ results }) => {
-        return text({
-          message: 'Where should we create your project?',
-          placeholder: './sparkling-solid',
-          validate: value => {
-            if (!value) return 'Please enter a path.';
-            if (value[0] !== '.') return 'Please enter a relative path.';
-          },
-        });
-      },
-
-      type: () =>
-        select({
-          message: 'What type of project you are creating?',
-          initialValue: 'web',
-          options: [
-            {
-              value: 'web',
-              label: 'Web',
-              hint: 'You will be choosing from a selection of templates provided by us.',
-            },
-            {
-              value: 'react-native',
-              label: 'React Native',
-              hint: 'This is a comprehensive example project provided by us. You will be building React Native powered by Re.Pack.',
-            },
-          ],
-        }),
-
-      templates: ({ results }) => {
-        if (results.type === 'web') {
-          return select({
-            message: 'Pick a template: ',
-            initialValue: 'react-rspack-mf',
-            maxItems: 5,
-            options: Object.keys(TEMPLATES).map(template => ({
-              value: template as keyof typeof TEMPLATES,
-              label: c.cyan(
-                TEMPLATES[template as keyof typeof TEMPLATES].label,
-              ),
-              hint: TEMPLATES[template as keyof typeof TEMPLATES].hint,
-            })),
-          });
-        }
-      },
-    },
-    {
-      onCancel: () => {
-        cancel('Operation cancelled.');
-        process.exit(0);
-      },
-    },
-  )) as CLIOptions;
-
-  const temp_dir = tempy.temporaryDirectory();
-  const command_web = `git clone --depth 1 https://github.com/ZephyrCloudIO/zephyr-examples.git -b main ${temp_dir}`;
-  const command_react_native = `git clone --depth 1 https://github.com/ZephyrCloudIO/zephyr-repack-example.git -b main ${temp_dir}`;
-
-  const project_path = project.path.replace('./', '').trim();
-  const s = spinner();
-  s.start(c.cyan(`Creating project in ${project_path}`));
-  const outputPath = path.join(process.cwd(), project.path);
-
-  try {
-    if (project.type === 'web') {
-      await new Promise<void>((resolve, reject) => {
-        exec(command_web, async err => {
-          if (err) {
-            s.stop(
-              c.bgRed(
-                c.black(`Error cloning repository to ${project_path}...`),
-              ),
-            );
-            return reject(err);
-          }
-
-          const clonedPath = path.join(
-            temp_dir,
-            'examples',
-            project.templates as string,
-          );
-
-          try {
-            // Remove .git folder from the cloned template
-            await fs.promises.rm(path.join(clonedPath, '.git'), {
-              recursive: true,
-              force: true,
-            });
-
-            await fs.promises.cp(clonedPath, outputPath, {
-              recursive: true,
-              force: true,
-            });
-            s.stop(
-              c.green(
-                `Project successfully created at ${c.underline(project_path)}`,
-              ),
-            );
-            resolve();
-          } catch (copyErr) {
-            s.stop(
-              c.bgRed(c.black(`Error copying template to ${project_path}...`)),
-            );
-            reject(copyErr);
-          }
-        });
-      });
-    } else if (project.type === 'react-native') {
-      await new Promise<void>((resolve, reject) => {
-        exec(command_react_native, async err => {
-          if (err) {
-            s.stop(
-              c.bgRed(
-                c.black(`Error cloning repository to ${project_path}...`),
-              ),
-            );
-            return reject(err);
-          }
-
-          try {
-            // Remove .git folder from the cloned template
-            await fs.promises.rm(path.join(temp_dir, '.git'), {
-              recursive: true,
-              force: true,
-            });
-
-            await fs.promises.cp(temp_dir, outputPath, {
-              recursive: true,
-              force: true,
-            });
-            s.stop(
-              c.green(
-                `Project successfully created at ${c.underline(project_path)}`,
-              ),
-            );
-            resolve();
-          } catch (copyErr) {
-            s.stop(
-              c.bgRed(c.black(`Error copying files to ${project_path}...`)),
-            );
-            reject(copyErr);
-          }
-        });
-      });
-    }
-
-    // Initialize Git only if user confirms
-    await initializeGit(outputPath);
-    note('Git repository and initial commit created successfully!');
-  } catch (error) {
-    console.error(error);
-    process.exit(2);
-  } finally {
-    await fs.promises.rm(temp_dir, { recursive: true, force: true });
-    end_note({ project });
-  }
-}
-
-main().catch(console.error);

package/package/utils/constants.ts

@@ -1,74 +0,0 @@
-const REPO_OWNER = 'ZephyrCloudIO';
-const REPO_NAME = 'zephyr-examples';
-const REPACK_REPO = 'zephyr-repack-example';
-
-const BASE_REPO = `${REPO_OWNER}/${REPO_NAME}`;
-
-const REPACK_REPO_PATH = `${REPO_OWNER}/${REPACK_REPO}`;
-
-const TEMPLATES = {
-  'rspack-project': {
-    label: 'React + Rspack',
-    hint: 'A simple application build by Rspack.',
-    framework: 'react',
-  },
-  'react-vite-ts': {
-    label: 'A simple React application build by Vite',
-    hint: 'You will be building React app powered by Vite.',
-    framework: 'react',
-  },
-  'react-vite-mf': {
-    label: 'React + Vite + Webpack + Rspack',
-    hint: 'You will be building federated React apps powered by Vite, Webpack and Rspack.',
-    framework: 'react',
-  },
-  'angular-vite': {
-    label: 'Angular app with Vite',
-    hint: 'You will be building an Angular app powered by Vite.',
-    framework: 'angular',
-  },
-  'react-webpack-mf': {
-    label: 'React + Webpack',
-    hint: 'A React application with Module Federation, using Webpack as the bundler.',
-    framework: 'react',
-  },
-  'nx-rspack-mf': {
-    label: 'React + Nx + Rspack',
-    hint: 'A React application with Module Federation, using Nx as Monorepo manager and Rspack as the bundler.',
-    framework: 'react',
-  },
-  'nx-webpack-mf': {
-    label: 'React + Nx + Webpack',
-    hint: 'React applications with Module Federation, using Nx as Monorepo manager and Webpack as the bundler.',
-    framework: 'react',
-  },
-  'ng-nx': {
-    label: 'Angular app with Nx',
-    hint: 'An Angular application with Nx as Monorepo manager.',
-    framework: 'angular',
-  },
-  'qwik-1.5': {
-    label: 'Qwik + Vite',
-    hint: 'A Qwik v1.5 app using Vite as the bundler.',
-    framework: 'qwik',
-  },
-  'react-rspack-tractor-2.0': {
-    label: 'React + Rspack + Tractor 2.0',
-    hint: 'A React application using Rspack as the bundler and Tractor 2.0 as the module federation manager.',
-    framework: 'react',
-  },
-  'turbo-rspack-mf': {
-    label: 'Turbo + Rspack + Module Federation',
-    hint: 'A monorepo using Turborepo, React, and Rspack as the bundler.',
-    framework: 'react',
-  },
-};
-
-export {
-  REPO_OWNER,
-  REPO_NAME,
-  REPACK_REPO,
-  BASE_REPO,
-  REPACK_REPO_PATH,
-  TEMPLATES,
-};

package/package/utils/end.ts

@@ -1,43 +0,0 @@
-import { exec } from 'node:child_process';
-import { note } from '@clack/prompts';
-import c from 'chalk';
-import type { CLIOptions } from './types';
-
-export default function end_note({ project }: { project: CLIOptions }) {
-  try {
-    exec('git config user.name', (err, stdout, stderr) => {
-      const user_name = stdout.toString().trim();
-      const repo_name = project.path.split('/').pop();
-
-      let next_steps: string[];
-
-      if (project.type === 'web') {
-        next_steps = [`cd ${repo_name}`, 'pnpm install', 'pnpm run build'];
-      } else {
-        next_steps = [
-          `cd ${repo_name}`,
-          'pnpm install',
-          c.magenta(
-            `git remote add origin https://github.com/${user_name.length >= 1 ? user_name : 'YourUsername'}/${repo_name}.git`,
-          ),
-          'ZC=1 pnpm run start',
-          '\n--------------------------------\n',
-          'Make sure to commit and add a remote to the remote repository!',
-          `Read more about how Module Federation works with Zephyr: ${c.underline(c.cyan('https://docs.zephyr-cloud.io/how-to/mf-guide'))}`,
-        ];
-      }
-
-      note(c.cyan(next_steps.join('\n')), 'Next steps.');
-    });
-  } catch (error) {
-    console.error(error);
-  } finally {
-    const end_notes = [
-      `Discord: ${c.underline(c.cyan('https://zephyr-cloud.io/discord'))}`,
-      `Documentation: ${project.type === 'web' ? c.underline(c.cyan('https://docs.zephyr-cloud.io/recipes')) : c.underline(c.cyan('https://docs.zephyr-cloud.io/recipes/repack-mf'))}`,
-      `Open an issue: ${c.underline(c.cyan('https://github.com/ZephyrCloudIO/create-zephyr-apps/issues'))}`,
-    ];
-
-    note(Object.values(end_notes).join('\n'), 'Problems?');
-  }
-}

package/package/utils/types.ts

@@ -1,32 +0,0 @@
-export interface GithubTreeItem {
-  path: string;
-  type: 'tree' | 'blob';
-}
-
-export interface ExampleMetadata {
-  name: string;
-  description: string;
-  path: string;
-}
-
-export interface WebCreationOptions {
-  path: string;
-  template: string;
-  framework: string;
-}
-
-export interface ReactNativeCreationOptions {
-  path: string;
-  // host_name: string;
-  //  remote_names: string[];
-}
-
-export interface CLIOptions {
-  path: string;
-  type: 'web' | 'react-native';
-  /** At the moment, if users opt for  web they will only be asked for a template without host name and remote_name */
-  templates: string | undefined;
-  //host_name: string | undefined;
-  //remote_names: string[] | undefined;
-  install: boolean;
-}

package/rslib.config.ts

@@ -1,41 +0,0 @@
-import { defineConfig } from '@rslib/core';
-
-export default defineConfig({
-  source: {
-    entry: {
-      index: './package/index.ts',
-    },
-  },
-  lib: [
-    {
-      format: 'cjs',
-      autoExtension: false,
-      syntax: 'es2020',
-      dts: {
-        build: true,
-      },
-      output: {
-        target: 'node',
-        filename: {
-          js: '[name].cjs',
-        },
-        cleanDistPath: true,
-      },
-    },
-    {
-      format: 'esm',
-      autoExtension: false,
-      syntax: 'es2020',
-      dts: {
-        build: true,
-      },
-      output: {
-        target: 'node',
-        filename: {
-          js: '[name].mjs',
-        },
-        cleanDistPath: true,
-      },
-    },
-  ],
-});

package/tsconfig.json

@@ -1,30 +0,0 @@
-{
-  "compilerOptions": {
-    // Enable latest features
-    "lib": ["ESNext"],
-    "target": "ES2020",
-    "module": "ES2020",
-    "moduleDetection": "force",
-
-    "allowJs": true,
-
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowSyntheticDefaultImports": true,
-    "allowImportingTsExtensions": true,
-    //"verbatimModuleSyntax": true,
-    "noEmit": true,
-
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false,
-    "outDir": "./dist",
-    "types": ["node"]
-  }
-}