@patternfly/patternfly-cli 1.0.2 → 1.0.4

package/src/cli.ts

@@ -2,26 +2,15 @@
 
 import { program } from 'commander';
 import { execa } from 'execa';
-import inquirer from 'inquirer';
 import fs from 'fs-extra';
 import path from 'path';
 import { defaultTemplates } from './templates.js';
 import { mergeTemplates } from './template-loader.js';
 import { offerAndCreateGitHubRepo } from './github.js';
+import { runCreate } from './create.js';
 import { runSave } from './save.js';
 import { runLoad } from './load.js';
-
-/** Project data provided by the user */
-type ProjectData = {
-  /** Project name */
-  name: string, 
-  /** Project version */
-  version: string,
-  /** Project description */
-  description: string,
-  /** Project author */
-  author: string
-}
+import { runDeployToGitHubPages } from './gh-pages.js';
 
 /** Command to create a new project */
 program
@@ -33,172 +22,14 @@ program
   .option('-t, --template-file <path>', 'Path to a JSON file with custom templates (same format as built-in)')
   .option('--ssh', 'Use SSH URL for cloning the template repository')
   .action(async (projectDirectory, templateName, options) => {
-    const templatesToUse = mergeTemplates(defaultTemplates, options?.templateFile);
-
-    // If project directory is not provided, prompt for it
-    if (!projectDirectory) {
-      const projectDirAnswer = await inquirer.prompt([
-        {
-          type: 'input',
-          name: 'projectDirectory',
-          message: 'Please provide the directory where you want to create the project?',
-          default: 'my-app',
-        },
-      ]);
-      projectDirectory = projectDirAnswer.projectDirectory;
-    }
-
-    // If template name is not provided, show available templates and let user select
-    if (!templateName) {
-      console.log('\n📋 Available templates:\n');
-      templatesToUse.forEach(t => {
-        console.log(`  ${t.name.padEnd(12)} - ${t.description}`);
-      });
-      console.log('');
-      
-      const templateQuestion = [
-        {
-          type: 'list',
-          name: 'templateName',
-          message: 'Select a template:',
-          choices: templatesToUse.map(t => ({
-            name: `${t.name} - ${t.description}`,
-            value: t.name
-          }))
-        }
-      ];
-      
-      const templateAnswer = await inquirer.prompt(templateQuestion);
-      templateName = templateAnswer.templateName;
-    }
-    
-    // Look up the template by name
-    const template = templatesToUse.find(t => t.name === templateName);
-    if (!template) {
-      console.error(`❌ Template "${templateName}" not found.\n`);
-      console.log('📋 Available templates:\n');
-      templatesToUse.forEach(t => {
-        console.log(`  ${t.name.padEnd(12)} - ${t.description}`);
+    try {
+      await runCreate(projectDirectory, templateName, {
+        templateFile: options?.templateFile,
+        ssh: options?.ssh,
       });
-      console.log('');
+    } catch {
       process.exit(1);
     }
-
-    // If --ssh was not passed, prompt whether to use SSH
-    let useSSH = options?.ssh;
-    if (useSSH === undefined && template.repoSSH) {
-      const sshAnswer = await inquirer.prompt([
-        {
-          type: 'confirm',
-          name: 'useSSH',
-          message: 'Use SSH URL for cloning?',
-          default: false,
-        },
-      ]);
-      useSSH = sshAnswer.useSSH;
-    }
-
-    const templateRepoUrl = useSSH && template.repoSSH ? template.repoSSH : template.repo;
-    
-    // Define the full path for the new project
-    const projectPath = path.resolve(projectDirectory);
-    console.log(`Cloning template "${templateName}" from ${templateRepoUrl} into ${projectPath}...`);
-
-    try {
-      
-      // Clone the repository
-      const cloneArgs = ['clone'];
-      if (template.options && Array.isArray(template.options)) {
-        cloneArgs.push(...template.options);
-      }
-      cloneArgs.push(templateRepoUrl, projectPath);
-      await execa('git', cloneArgs, { stdio: 'inherit' });
-      console.log('✅ Template cloned successfully.');
-
-      // Remove the .git folder from the *new* project
-      await fs.remove(path.join(projectPath, '.git'));
-      console.log('🧹 Cleaned up template .git directory.');
-
-      // Ask user for customization details
-      const questions = [
-        {
-          type: 'input',
-          name: 'name',
-          message: 'What is the project name?',
-          default: path.basename(projectPath),
-        },
-        {
-          type: 'input',
-          name: 'version',
-          message: 'What version number would you like to use?',
-          default: '1.0.0',
-        },
-        {
-          type: 'input',
-          name: 'description',
-          message: 'What is the project description?',
-          default: '',
-        },
-        {
-          type: 'input',
-          name: 'author',
-          message: 'Who is the author of the project?',
-          default: '',
-        },
-      ];
-
-      const answers: ProjectData = await inquirer.prompt(questions);
-
-      // Update the package.json in the new project
-      const pkgJsonPath = path.join(projectPath, 'package.json');
-      
-      if (await fs.pathExists(pkgJsonPath)) {
-        const pkgJson = await fs.readJson(pkgJsonPath);
-        
-        // Overwrite fields with user's answers
-        pkgJson.name = answers.name;
-        pkgJson.version = answers.version;
-        pkgJson.description = answers.description;
-        pkgJson.author = answers.author;
-        
-        // Write the updated package.json back
-        await fs.writeJson(pkgJsonPath, pkgJson, { spaces: 2 });
-        console.log('📝 Customized package.json.');
-      } else {
-        console.log('ℹ️ No package.json found in template, skipping customization.');
-      }
-
-      const packageManager = template.packageManager || "npm";
-      // Install dependencies
-      console.log('📦 Installing dependencies... (This may take a moment)');
-      await execa(packageManager, ['install'], { cwd: projectPath, stdio: 'inherit' });
-      console.log('✅ Dependencies installed.');
-
-      // Optional: Create GitHub repository
-      await offerAndCreateGitHubRepo(projectPath);
-
-      // Let the user know the project was created successfully
-      console.log('\n✨ Project created successfully! ✨\n');
-      console.log(`To get started:`);
-      console.log(`  cd ${projectDirectory}`);
-      console.log('  Happy coding! 🚀');
-
-    } catch (error) {
-      console.error('❌ An error occurred:');
-      if (error instanceof Error) {
-        console.error(error.message);
-      } else if (error && typeof error === 'object' && 'stderr' in error) {
-        console.error((error as { stderr?: string }).stderr || String(error));
-      } else {
-        console.error(String(error));
-      }
-      
-      // Clean up the created directory if an error occurred
-      if (await fs.pathExists(projectPath)) {
-        await fs.remove(projectPath);
-        console.log('🧹 Cleaned up failed project directory.');
-      }
-    }
   });
 
 /** Command to initialize a project and optionally create a GitHub repository */
@@ -304,4 +135,30 @@ program
     }
   });
 
+/** Command to deploy the React app to GitHub Pages */
+program
+  .command('deploy')
+  .description('Build the app and deploy it to GitHub Pages (uses gh-pages branch)')
+  .argument('[path]', 'Path to the project (defaults to current directory)')
+  .option('-d, --dist-dir <dir>', 'Build output directory to deploy', 'dist')
+  .option('--no-build', 'Skip running the build step (deploy existing output only)')
+  .option('-b, --branch <branch>', 'Git branch to deploy to', 'gh-pages')
+  .action(async (projectPath, options) => {
+    const cwd = projectPath ? path.resolve(projectPath) : process.cwd();
+    try {
+      await runDeployToGitHubPages(cwd, {
+        distDir: options.distDir,
+        skipBuild: options.build === false,
+        branch: options.branch,
+      });
+    } catch (error) {
+      if (error instanceof Error) {
+        console.error(`\n❌ ${error.message}\n`);
+      } else {
+        console.error(error);
+      }
+      process.exit(1);
+    }
+  });
+
 program.parse(process.argv);

package/src/create.ts

@@ -0,0 +1,187 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { execa } from 'execa';
+import inquirer from 'inquirer';
+import { defaultTemplates } from './templates.js';
+import { mergeTemplates } from './template-loader.js';
+import { offerAndCreateGitHubRepo } from './github.js';
+
+/** Project data provided by the user */
+type ProjectData = {
+  /** Project name */
+  name: string;
+  /** Project version */
+  version: string;
+  /** Project description */
+  description: string;
+  /** Project author */
+  author: string;
+};
+
+export type RunCreateOptions = {
+  templateFile?: string;
+  ssh?: boolean;
+};
+
+/**
+ * Runs the create flow: clone template, customize package.json, install deps, optionally create GitHub repo.
+ * Throws on fatal errors. Caller should catch and process.exit(1).
+ */
+export async function runCreate(
+  projectDirectory: string | undefined,
+  templateName: string | undefined,
+  options?: RunCreateOptions
+): Promise<void> {
+  const templatesToUse = mergeTemplates(defaultTemplates, options?.templateFile);
+
+  // If project directory is not provided, prompt for it
+  if (!projectDirectory) {
+    const projectDirAnswer = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'projectDirectory',
+        message: 'Please provide the directory where you want to create the project?',
+        default: 'my-app',
+      },
+    ]);
+    projectDirectory = projectDirAnswer.projectDirectory;
+  }
+
+  // If template name is not provided, show available templates and let user select
+  if (!templateName) {
+    console.log('\n📋 Available templates:\n');
+    templatesToUse.forEach(t => {
+      console.log(`  ${t.name.padEnd(12)} - ${t.description}`);
+    });
+    console.log('');
+
+    const templateQuestion = [
+      {
+        type: 'list',
+        name: 'templateName',
+        message: 'Select a template:',
+        choices: templatesToUse.map(t => ({
+          name: `${t.name} - ${t.description}`,
+          value: t.name,
+        })),
+      },
+    ];
+
+    const templateAnswer = await inquirer.prompt(templateQuestion);
+    templateName = templateAnswer.templateName;
+  }
+
+  // Look up the template by name
+  const template = templatesToUse.find(t => t.name === templateName);
+  if (!template) {
+    console.error(`❌ Template "${templateName}" not found.\n`);
+    console.log('📋 Available templates:\n');
+    templatesToUse.forEach(t => {
+      console.log(`  ${t.name.padEnd(12)} - ${t.description}`);
+    });
+    console.log('');
+    throw new Error(`Template "${templateName}" not found`);
+  }
+
+  const templateRepoUrl = options?.ssh && template.repoSSH ? template.repoSSH : template.repo;
+
+  // Define the full path for the new project (projectDirectory is set above via arg or prompt)
+  const dir = projectDirectory ?? 'my-app';
+  const projectPath = path.resolve(dir);
+  console.log(`Cloning template "${templateName}" from ${templateRepoUrl} into ${projectPath}...`);
+
+  try {
+    // Clone the repository
+    const cloneArgs = ['clone'];
+    if (template.options && Array.isArray(template.options)) {
+      cloneArgs.push(...template.options);
+    }
+    cloneArgs.push(templateRepoUrl, projectPath);
+    await execa('git', cloneArgs, { stdio: 'inherit' });
+    console.log('✅ Template cloned successfully.');
+
+    // Remove the .git folder from the *new* project
+    await fs.remove(path.join(projectPath, '.git'));
+    console.log('🧹 Cleaned up template .git directory.');
+
+    // Ask user for customization details
+    const questions = [
+      {
+        type: 'input',
+        name: 'name',
+        message: 'What is the project name?',
+        default: path.basename(projectPath),
+      },
+      {
+        type: 'input',
+        name: 'version',
+        message: 'What version number would you like to use?',
+        default: '1.0.0',
+      },
+      {
+        type: 'input',
+        name: 'description',
+        message: 'What is the project description?',
+        default: '',
+      },
+      {
+        type: 'input',
+        name: 'author',
+        message: 'Who is the author of the project?',
+        default: '',
+      },
+    ];
+
+    const answers: ProjectData = await inquirer.prompt(questions);
+
+    // Update the package.json in the new project
+    const pkgJsonPath = path.join(projectPath, 'package.json');
+
+    if (await fs.pathExists(pkgJsonPath)) {
+      const pkgJson = await fs.readJson(pkgJsonPath);
+
+      // Overwrite fields with user's answers
+      pkgJson.name = answers.name;
+      pkgJson.version = answers.version;
+      pkgJson.description = answers.description;
+      pkgJson.author = answers.author;
+
+      // Write the updated package.json back
+      await fs.writeJson(pkgJsonPath, pkgJson, { spaces: 2 });
+      console.log('📝 Customized package.json.');
+    } else {
+      console.log('ℹ️ No package.json found in template, skipping customization.');
+    }
+
+    const packageManager = template.packageManager || 'npm';
+    // Install dependencies
+    console.log('📦 Installing dependencies... (This may take a moment)');
+    await execa(packageManager, ['install'], { cwd: projectPath, stdio: 'inherit' });
+    console.log('✅ Dependencies installed.');
+
+    // Optional: Create GitHub repository
+    await offerAndCreateGitHubRepo(projectPath);
+
+    // Let the user know the project was created successfully
+    console.log('\n✨ Project created successfully! ✨\n');
+    console.log(`To get started:`);
+    console.log(`  cd ${dir}`);
+    console.log('  Happy coding! 🚀');
+  } catch (error) {
+    console.error('❌ An error occurred:');
+    if (error instanceof Error) {
+      console.error(error.message);
+    } else if (error && typeof error === 'object' && 'stderr' in error) {
+      console.error((error as { stderr?: string }).stderr || String(error));
+    } else {
+      console.error(String(error));
+    }
+
+    // Clean up the created directory if an error occurred
+    if (await fs.pathExists(projectPath)) {
+      await fs.remove(projectPath);
+      console.log('🧹 Cleaned up failed project directory.');
+    }
+    throw error;
+  }
+}

package/src/gh-pages.ts

@@ -0,0 +1,170 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { execa } from 'execa';
+import ghPages from 'gh-pages';
+import { checkGhAuth } from './github.js';
+
+export type DeployOptions = {
+  /** Build output directory to deploy (e.g. dist, build) */
+  distDir: string;
+  /** Skip running the build step */
+  skipBuild: boolean;
+  /** Branch to push to (default gh-pages) */
+  branch: string;
+};
+
+const DEFAULT_DIST_DIR = 'dist';
+const DEFAULT_BRANCH = 'gh-pages';
+
+/**
+ * Parse owner and repo name from a Git remote URL.
+ * Supports https://github.com/owner/repo, https://github.com/owner/repo.git, git@github.com:owner/repo.git
+ */
+function parseRepoFromUrl(repoUrl: string): { owner: string; repo: string } | null {
+  const trimmed = repoUrl.trim().replace(/\.git$/, '');
+  // git@github.com:owner/repo or https://github.com/owner/repo
+  const sshMatch = trimmed.match(/git@github\.com:([^/]+)\/([^/]+)/);
+  if (sshMatch?.[1] && sshMatch[2]) {
+    return { owner: sshMatch[1], repo: sshMatch[2] };
+  }
+  const httpsMatch = trimmed.match(/github\.com[/:]([^/]+)\/([^/#?]+)/);
+  if (httpsMatch?.[1] && httpsMatch[2]) {
+    return { owner: httpsMatch[1], repo: httpsMatch[2] };
+  }
+  return null;
+}
+
+/**
+ * Ensure GitHub Pages is enabled for the repository, configured to use the given branch.
+ * Uses the GitHub API via `gh` CLI. No-op if gh is not authenticated or on failure.
+ */
+async function ensurePagesEnabled(owner: string, repo: string, branch: string): Promise<void> {
+  const auth = await checkGhAuth();
+  if (!auth.ok) return;
+
+  const body = JSON.stringify({ source: { branch, path: '/' } });
+  try {
+    const getResult = await execa('gh', ['api', `repos/${owner}/${repo}/pages`, '--jq', '.source.branch'], {
+      reject: false,
+      encoding: 'utf8',
+    });
+    if (getResult.exitCode === 0) {
+      const currentBranch = getResult.stdout?.trim();
+      if (currentBranch === branch) return;
+      await execa('gh', [
+        'api',
+        '-X',
+        'PUT',
+        `repos/${owner}/${repo}/pages`,
+        '--input',
+        '-',
+      ], { input: body });
+      console.log(`   GitHub Pages source updated to branch "${branch}".`);
+    } else {
+      await execa('gh', [
+        'api',
+        '-X',
+        'POST',
+        `repos/${owner}/${repo}/pages`,
+        '--input',
+        '-',
+      ], { input: body });
+      console.log(`   GitHub Pages enabled (source: branch "${branch}").`);
+    }
+  } catch {
+    // Best-effort: continue without enabling; user can enable manually
+  }
+}
+
+/**
+ * Detect package manager from lock files.
+ */
+async function getPackageManager(cwd: string): Promise<'yarn' | 'pnpm' | 'npm'> {
+  if (await fs.pathExists(path.join(cwd, 'yarn.lock'))) return 'yarn';
+  if (await fs.pathExists(path.join(cwd, 'pnpm-lock.yaml'))) return 'pnpm';
+  return 'npm';
+}
+
+/**
+ * Run build script in the project (npm run build / yarn build / pnpm build).
+ */
+async function runBuild(cwd: string): Promise<void> {
+  const pkgPath = path.join(cwd, 'package.json');
+  const pkg = await fs.readJson(pkgPath);
+  const scripts = (pkg.scripts as Record<string, string>) || {};
+  if (!scripts['build']) {
+    throw new Error(
+      'No "build" script found in package.json. Add a build script or use --no-build and deploy an existing folder with -d/--dist-dir.'
+    );
+  }
+
+  const pm = await getPackageManager(cwd);
+  const runCmd = pm === 'npm' ? 'npm' : pm === 'yarn' ? 'yarn' : 'pnpm';
+  const args = pm === 'npm' ? ['run', 'build'] : ['build'];
+  console.log(`📦 Running build (${runCmd} ${args.join(' ')})...`);
+  await execa(runCmd, args, { cwd, stdio: 'inherit' });
+  console.log('✅ Build completed.\n');
+}
+
+/**
+ * Deploy the built app to GitHub Pages using the gh-pages package.
+ * Builds the project first unless skipBuild is true, then publishes distDir to the gh-pages branch.
+ */
+export async function runDeployToGitHubPages(
+  projectPath: string,
+  options: Partial<DeployOptions> = {}
+): Promise<void> {
+  const distDir = options.distDir ?? DEFAULT_DIST_DIR;
+  const skipBuild = options.skipBuild ?? false;
+  const branch = options.branch ?? DEFAULT_BRANCH;
+
+  const cwd = path.resolve(projectPath);
+  const pkgPath = path.join(cwd, 'package.json');
+
+  if (!(await fs.pathExists(pkgPath))) {
+    throw new Error(
+      'No package.json found in this directory. Run this command from your project root (or pass the project path).'
+    );
+  }
+
+  let repoUrl: string;
+  try {
+    const { stdout } = await execa('git', ['remote', 'get-url', 'origin'], {
+      cwd,
+      reject: true,
+    });
+    repoUrl = stdout.trim();
+  } catch {
+    throw new Error(
+      'Please save your changes first, before deploying to GitHub Pages.'
+    );
+  }
+
+  if (!skipBuild) {
+    await runBuild(cwd);
+  }
+
+  const absoluteDist = path.join(cwd, distDir);
+  if (!(await fs.pathExists(absoluteDist))) {
+    throw new Error(
+      `Build output directory "${distDir}" does not exist. Run a build first or specify the correct directory with -d/--dist-dir.`
+    );
+  }
+
+  const parsed = parseRepoFromUrl(repoUrl);
+  if (parsed) {
+    await ensurePagesEnabled(parsed.owner, parsed.repo, branch);
+  }
+
+  console.log(`🚀 Deploying "${distDir}" to GitHub Pages (branch: ${branch})...`);
+  await new Promise<void>((resolve, reject) => {
+    ghPages.publish(
+      absoluteDist,
+      { branch, repo: repoUrl },
+      (err) => (err ? reject(err) : resolve())
+    );
+  });
+  console.log('\n✅ Deployed to GitHub Pages.');
+  console.log('   Enable GitHub Pages in your repo: Settings → Pages → Source: branch "' + branch + '".');
+  console.log('   If the site is at username.github.io/<repo-name>, set your app\'s base path (e.g. base: \'/<repo-name>/\' in Vite).\n');
+}