@cellajs/create-cella 0.1.7 → 0.2.1

package/src/create.ts

@@ -1,193 +0,0 @@
-import { mkdir } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import { join, relative } from 'node:path';
-import colors from 'picocolors';
-import { downloadTemplate } from 'giget';
-import yoctoSpinner from 'yocto-spinner';
-
-import { TEMPLATE_URL } from './constants.ts';
-
-import { install, generate } from './utils/run-package-manager-command.ts';
-import { cleanTemplate } from './utils/clean-template.ts';
-import { runGitCommand } from './utils/run-git-command.ts';
-import { addRemote } from './add-remote.ts';
-
-interface CreateOptions {
-  projectName: string;
-  targetFolder: string;
-  newBranchName?: string | null;
-  skipInstall: boolean;
-  skipGit: boolean;
-  skipClean: boolean;
-  skipGenerate: boolean;
-  packageManager: string;
-}
-
-export async function create({
-  projectName,
-  targetFolder,
-  newBranchName,
-  skipInstall,
-  skipGit,
-  skipClean,
-  skipGenerate,
-  packageManager,
-}: CreateOptions): Promise<void> {
-  // Save the original working directory
-  const originalCwd = process.cwd();
-
-  console.info();
-
-  // Create the target folder if it doesn't exist
-  const createFolderSpinner = yoctoSpinner({
-    text: 'Creating project folder',
-  }).start();
-
-  await mkdir(targetFolder, { recursive: true });
-  process.chdir(targetFolder);
-
-  createFolderSpinner.success('Project folder created');
-
-  // Download the template from the specified URL
-  const downloadSpinner = yoctoSpinner({
-    text: 'Downloading `cella` template',
-  }).start();
-
-  await downloadTemplate(TEMPLATE_URL, {
-    cwd: process.cwd(),
-    dir: targetFolder,
-    force: true,
-    provider: 'github',
-  });
-
-  downloadSpinner.success('`cella` template downloaded');
-
-  // Clean the template if the skipClean flag is not set
-  if (!skipClean) {
-    const cleanSpinner = yoctoSpinner({
-      text: 'cleaning `cella` template',
-    }).start();
-
-    try {
-      await cleanTemplate({
-        targetFolder,
-        projectName,
-      });
-      cleanSpinner.success('`cella` template cleaned');
-    } catch (e) {
-      console.error(e);
-      cleanSpinner.error('Failed to clean `cella` template');
-      process.exit(1);
-    }
-  } else {
-    console.info(`${colors.yellow('⚠')} --skip-clean > Skip cleaning \`cella\` template`);
-  }
-
-  // Install dependencies if the skipInstall flag is not set
-  if (!skipInstall) {
-    const installSpinner = yoctoSpinner({
-      text: 'installing dependencies',
-    }).start();
-
-    try {
-      await install(packageManager);
-      installSpinner.success('Dependencies installed');
-    } catch (e) {
-      console.error(e);
-      installSpinner.error('Failed to install dependencies');
-      process.exit(1);
-    }
-  } else {
-    console.info(`${colors.yellow('⚠')} --skip-install > Skip installing dependencies`);
-  }
-
-  // Generate SQL files if the skipGenerate flag is not set
-  if (!skipGenerate) {
-    const generateSpinner = yoctoSpinner({
-      text: 'generating SQL files',
-    }).start();
-
-    try {
-      await generate(packageManager);
-      generateSpinner.success('SQL files generated');
-    } catch (e) {
-      console.error(e);
-      generateSpinner.error('Failed to generate SQL files');
-      process.exit(1);
-    }
-  } else {
-    console.info(`${colors.yellow('⚠')} --skip-generate > Skip generating SQL files`);
-  }
-
-  // Initialize Git repository if skipGit flag is not set
-  if (!skipGit) {
-    const gitSpinner = yoctoSpinner({
-      text: 'initializing git repository',
-    }).start();
-
-    const gitFolderPath = join(targetFolder, '.git');
-
-    if (!existsSync(gitFolderPath)) {
-      try {
-        // Run Git commands to initialize the repository and make the first commit
-        await runGitCommand({ targetFolder, command: 'init' });
-        await runGitCommand({ targetFolder, command: 'add .' });
-        await runGitCommand({ targetFolder, command: 'commit -m "Initial commit"' });
-
-        // If a new branch name is specified, create and checkout the branch
-        if (newBranchName) {
-          await runGitCommand({ targetFolder, command: `branch ${newBranchName}` });
-          await runGitCommand({ targetFolder, command: `checkout ${newBranchName}` });
-          gitSpinner.success(`Git repository initialized, initial commit created, and new branch ${newBranchName} created`);
-        } else {
-          gitSpinner.success('Git repository initialized and initial commit created');
-        }
-      } catch (e) {
-        console.error(e);
-        gitSpinner.error('Failed to initialize Git repository or create branch');
-        process.exit(1);
-      }
-    } else {
-      gitSpinner.warning('Git repository already initialized > Skip git init');
-    }
-  } else {
-    console.info(`${colors.yellow('⚠')} --skip-git > Skip git init`);
-  }
-
-  // Add Cella as upstream remote
-  await addRemote({ targetFolder });
-
-  // Final success message indicating project creation
-  console.info();
-  console.info(`${colors.green('Success')} Created ${projectName} at ${targetFolder}`);
-  console.info();
-
-  // Check if the working directory needs to be changed
-  const needsCd = originalCwd !== targetFolder;
-  const relativePath = relative(originalCwd, targetFolder);
-
-  if (needsCd) {
-    // Calculate the relative path between the original working directory and the target folder
-    console.info('now go to your project using:');
-    console.info(colors.cyan(`  cd ${relativePath}`)); // Adding './' to make it clear it's a relative path
-    console.info();
-  }
-
-  console.info(`${needsCd ? 'then ' : ''}quick start using pglite with:`);
-  console.info(colors.cyan(`  ${packageManager} quick`));
-  console.info();
-
-  console.info('Already have docker installed? Then you can run a full setup:');
-  console.info(colors.cyan(`  ${packageManager} docker`));
-  console.info(colors.cyan(`  ${packageManager} dev`));
-  console.info(colors.cyan(`  ${packageManager} seed`));
-  console.info();
-
-  console.info(`Once running, you can sign in using:`);
-  console.info(`email: ${colors.greenBright('admin-test@cellajs.com')}`);
-  console.info(`password: ${colors.greenBright('12345678')}`);
-  console.info();
-  console.info(`For more info, check out: ${relativePath}/README.md`);
-  console.info(`Enjoy building ${projectName} using cella! 🎉`);
-  console.info();
-}

package/src/index.ts

@@ -1,137 +0,0 @@
-#!/usr/bin/env tsx
-
-import { basename, resolve } from 'node:path';
-import { existsSync } from 'node:fs';
-import colors from 'picocolors';
-
-import { input, confirm, select } from '@inquirer/prompts';
-
-import { cli } from './cli';
-import { extractPackageJsonVersionFromUri } from './utils/extract-package-json-version-from-uri';
-import { validateProjectName } from './utils/validate-project-name.ts';
-import { isEmptyDirectory } from './utils/is-empty-directory.ts';
-import { create } from './create.ts';
-import { LOGO, VERSION, WEBSITE, AUTHOR, GITHUB, DESCRIPTION, TEMPLATE_URL } from './constants.ts';
-
-interface CreateOptions {
-  projectName: string;
-  targetFolder: string;
-  newBranchName?: string | null;
-  skipInstall: boolean;
-  skipGit: boolean;
-  skipClean: boolean;
-  skipGenerate: boolean;
-  packageManager: string;
-}
-
-async function main(): Promise<void> {
-  console.info(LOGO);
-
-  // Get the latest version of the template
-  const templateVersion = await extractPackageJsonVersionFromUri(TEMPLATE_URL);
-
-  // Display CLI version and created by information
-  console.info();
-  console.info(DESCRIPTION);
-  console.info();
-  console.info(`Cella version: ${colors.green(templateVersion)}`);
-  console.info(`Cli version ${colors.green(VERSION)}`);
-  console.info(`Created by ${AUTHOR}`);
-  console.info(`${GITHUB} | ${WEBSITE}`);
-  console.info();
-
-  // Skip creating a new branch if --skipNewBranch flag is provided or git is skipped
-  if (cli.options.skipNewBranch || cli.options.skipGit) {
-    cli.createNewBranch = false;
-    cli.newBranchName = null;
-  }
-
-  // Skip generating sql files if --skipGenerate flag is provided
-  if (cli.options.skipGenerate === true) {
-    cli.options.skipGenerate = true;
-  }
-
-  // Skip installing packages if --skipInstall flag is provided
-  if (cli.options.skipInstall === true) {
-    cli.options.skipInstall = true;
-  }
-
-  // Skip cleaning the template if --skipClean flag is provided
-  if (cli.options.skipClean === true) {
-    cli.options.skipClean = true;
-  }
-
-  // Skip initializing git if --skipGit flag is provided
-  if (cli.options.skipGit === true) {
-    cli.options.skipGit = true;
-  }
-
-  // Prompt for project name if not provided
-  if (!cli.directory) {
-    cli.directory = await input({
-      message: 'Enter your project name',
-      default: 'my-cella-app',
-      validate: (name) => {
-        const validation = validateProjectName(basename(resolve(name)));
-        return validation.valid ? true : `Invalid project name: ${validation.problems[0]}`;
-      },
-    });
-  }
-
-  // Prompt to create a new branch besides the main branch (if not skipped)
-  if (cli.createNewBranch === null) {
-    cli.createNewBranch = await confirm({
-      message: 'Would you like to create a new branch (besides "main")?',
-      default: true,
-    });
-  }
-
-  // Prompt for new branch name, only if user opted to create a new branch
-  if (!cli.newBranchName && cli.createNewBranch) {
-    cli.newBranchName = await input({
-      message: 'Enter the new branch name',
-      default: 'development',
-      validate: (name) => {
-        const validation = validateProjectName(basename(resolve(name)));
-        return validation.valid ? true : `Invalid branch name: ${validation.problems[0]}`;
-      },
-    });
-  }
-
-  const targetFolder = resolve(cli.directory);
-  const projectName = basename(targetFolder);
-
-  // Check if the target folder exists and is not empty
-  if (existsSync(targetFolder) && !(await isEmptyDirectory(targetFolder))) {
-    const dirName = cli.directory === '.' ? 'Current directory' : `Target directory "${targetFolder}"`;
-    const message = `${dirName} is not empty. Please choose how you would like to proceed:`;
-
-    const action = await select({
-      message,
-      choices: [
-        { name: 'Cancel and exit', value: 'cancel' },
-        { name: 'Ignore existing files and continue', value: 'ignore' },
-      ],
-    });
-
-    if (action === 'cancel') {
-      process.exit(1);
-    }
-  }
-
-  // Proceed with the project creation
-  const createOptions: CreateOptions = {
-    projectName,
-    targetFolder,
-    newBranchName: cli.newBranchName,
-    skipInstall: cli.options.skipInstall,
-    skipGit: cli.options.skipGit,
-    skipClean: cli.options.skipClean,
-    skipGenerate: cli.options.skipGenerate,
-    packageManager: cli.packageManager,
-  };
-
-  await create(createOptions);
-}
-
-main().catch(console.error);

package/src/utils/clean-template.ts

@@ -1,150 +0,0 @@
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import colors from 'picocolors';
-
-import { TO_CLEAN, TO_REMOVE, TO_COPY, TO_EDIT } from '../constants.ts';
-
-/**
- * Cleans the specified template by removing designated folders and files.
- * @param params - Parameters containing the target folder and project name.
- */
-export async function cleanTemplate({
-  targetFolder,
-  projectName,
-}: {
-  targetFolder: string;
-  projectName: string;
-}): Promise<void> {
-  // Change the current working directory to targetFolder if not already set
-  if (process.cwd() !== targetFolder) {
-    process.chdir(targetFolder);
-  }
-
-  return new Promise<void>(async (resolve, reject) => {
-    try {
-      // Copy specified files
-      for (const [src, dest] of Object.entries(TO_COPY)) {
-        const srcAbsolutePath = path.resolve(targetFolder, src);
-        const destAbsolutePath = path.resolve(targetFolder, dest);
-        await copyFile(srcAbsolutePath, destAbsolutePath);
-      }
-
-      // Clean specified folder contents
-      await Promise.all(
-        TO_CLEAN.map((folderPath) => {
-          const absolutePath = path.resolve(targetFolder, folderPath);
-          return removeFolderContents(absolutePath);
-        })
-      );
-
-      // Remove specified files and folders
-      await Promise.all(
-        TO_REMOVE.map((filePath) => {
-          const absolutePath = path.resolve(targetFolder, filePath);
-          return removeFileOrFolder(absolutePath);
-        })
-      );
-
-      // Edit specific files
-      await Promise.all(Object.entries(TO_EDIT).map(async ([filePath, edits]) => {
-          const absolutePath = path.resolve(targetFolder, filePath);
-          await editFile(absolutePath, edits);
-        })
-      );
-
-      resolve();
-    } catch (err) {
-      reject(`Error during the cleaning process: ${err}`);
-    }
-  });
-}
-
-/**
- * Removes all contents within a specified folder.
- * @param folderPath - The path of the folder to clean.
- */
-export async function removeFolderContents(folderPath: string): Promise<void> {
-  // List all files in the folder
-  const files = await fs.readdir(folderPath);
-
-  await Promise.all(
-    files.map(async (file) => {
-      const filePath = path.join(folderPath, file);
-
-      // Get the file or folder statistics
-      const stat = await fs.lstat(filePath);
-
-      // If it's a directory, remove it and all its contents
-      if (stat.isDirectory()) {
-        await fs.rm(filePath, { recursive: true, force: true });
-      } else {
-        // If it's a file, remove it
-        await fs.rm(filePath);
-      }
-    })
-  );
-}
-
-/**
- * Removes a specified file or folder.
- * @param pathToRemove - The path to the file or folder to remove.
- */
-export async function removeFileOrFolder(pathToRemove: string): Promise<void> {
-  await fs.rm(pathToRemove, { recursive: true, force: true });
-}
-
-/**
- * Helper function to copy files if the source exists.
- * @param src - The source file path.
- * @param dest - The destination file path.
- */
-export async function copyFile(src: string, dest: string): Promise<void> {
-  try {
-    // Check if the source file exists
-    await fs.access(src);
-
-    // Ensure the destination directory exists
-    await fs.mkdir(path.dirname(dest), { recursive: true });
-
-    // Copy the file
-    await fs.copyFile(src, dest);
-  } catch (err: any) {
-    if (err.code === 'ENOENT') {
-      console.info(`\n${colors.yellow('⚠')} Source file "${src}" does not exist > Skip copy`);
-    } else {
-      throw err;
-    }
-  }
-}
-
-/**
- * Helper function edit a file by applying regex replacements.
- * @param filePath - The path of the file to edit.
- * @param edits - The list of edits to apply.
- */
-export async function editFile(filePath: string, edits: Array<{regexMatch: RegExp; replaceWith: string }>): Promise<void> {
-  try {
-    await fs.access(filePath);
-
-    // Read the existing file content
-    const fileContent = await fs.readFile(filePath, 'utf8');
-    let updatedContent = fileContent;
-
-    // Apply each edit to the content
-    edits.forEach(({ regexMatch, replaceWith }) => {
-      updatedContent = updatedContent.replace(regexMatch, replaceWith);
-    });
-
-    // Write the updated content back to the file
-    if (fileContent !== updatedContent) {
-      await fs.writeFile(filePath, updatedContent, 'utf8');
-    }
-
-  } catch (err: any) {
-    if (err.code === 'ENOENT') {
-      console.info(`\n${colors.yellow('⚠')} Source file "${filePath}" does not exist > Skip edit`);
-    } else {
-      throw err;
-    }
-  }
-}

package/src/utils/extract-package-json-version-from-uri.ts

@@ -1,29 +0,0 @@
-import axios from 'axios';
-
-/**
- * Retrieves the version from the package.json file of a GitHub repository.
- * If the package.json file is not found or an error occurs, it returns 'unknown'.
- * 
- * @param repositoryUrl {string} - The GitHub repository URL in the format 'github:user/repo'.
- * @param branch {string} - The branch name (defaults to 'main').
- * @returns {Promise<string>} - The version from the package.json file.
- */
-export async function extractPackageJsonVersionFromUri(repositoryUrl: string, branch: string = 'main'): Promise<string> {
-  // Extract owner and repo from the URL
-  const [owner, repo] = repositoryUrl.replace('github:', '').split('/');
-  
-  // Construct the URL for the package.json file in the provided branch
-  const packageJsonUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${branch}/package.json`;
-
-  try {
-    // Fetch the package.json file
-    const response = await axios.get(packageJsonUrl);
-    const packageJson = response.data;
-    
-    // Return the version from the package.json, or 'unknown' if not found
-    return packageJson.version || 'unknown';
-  } catch (error) {
-    // If there's an error (file not found, etc.), return 'unknown'
-    return 'unknown';
-  }
-}

package/src/utils/is-empty-directory.ts

@@ -1,15 +0,0 @@
-import { readdir } from 'node:fs/promises';
-
-/**
- * Checks if a directory is empty or only contains a .git directory.
- * 
- * @param path - The path of the directory to check.
- * @returns Resolves to true if the directory is empty or contains only a .git folder, false otherwise.
- * @throws Throws an error if the path is not a directory or if there's an issue reading the directory.
- */
-export async function isEmptyDirectory(path: string): Promise<boolean> {
-  const files = await readdir(path);
-
-  // Check if directory is empty or contains only the .git directory
-  return files.length === 0 || (files.length === 1 && files[0] === '.git');
-}

package/src/utils/run-git-command.ts

@@ -1,57 +0,0 @@
-import { spawn } from 'node:child_process';
-
-type GitCommandType = 'merge' | 'diff' | 'other';
-
-interface RunGitCommandOptions {
-  targetFolder: string;
-  command: string;
-}
-
-// Helper to determine the type of Git command for custom handling
-function getGitCommandType(command: string): GitCommandType {
-  if (command.startsWith('merge')) return 'merge';
-  if (command.startsWith('diff')) return 'diff';
-  return 'other';
-}
-
-// Helper to check if a Git command is successful
-function isGitCommandSuccess(gitCommand: GitCommandType, code: number | null, errOutput: string): boolean {
-  if (gitCommand === 'merge') return code === 0 || (code === 1 && !errOutput);
-  if (gitCommand === 'diff') return code === 0 || (code === 2 && !errOutput);
-  return code === 0;
-}
-
-// Function to run a Git command and handle its output
-export async function runGitCommand({ targetFolder, command }: RunGitCommandOptions): Promise<string> {
-  return new Promise((resolve, reject) => {
-    const gitCommand = getGitCommandType(command);
-    const child = spawn(`git ${command}`, [], { cwd: targetFolder, shell: true, timeout: 60000 });
-
-    let output = '';
-    let errOutput = '';
-
-    child.on('error', (error: Error) => {
-      reject(error);
-    });
-
-    child.on('exit', (code: number | null) => {
-      if (isGitCommandSuccess(gitCommand, code, errOutput)) {
-        resolve(output.trim());
-      } else {
-        reject(
-          `Git ${gitCommand} command failed with exit code ${code}, stderr: "${errOutput.trim()}", stdout: "${output.trim()}"`
-        );
-      }
-    });
-
-    // Collect stdout data
-    child.stdout.on('data', (data: Buffer) => {
-      output += data.toString();
-    });
-
-    // Collect stderr data
-    child.stderr.on('data', (data: Buffer) => {
-      errOutput += data.toString();
-    });
-  });
-}

package/src/utils/run-package-manager-command.ts

@@ -1,74 +0,0 @@
-import spawn from 'cross-spawn';
-
-/**
- * Executes a command using the specified package manager (e.g., pnpm).
- * 
- * @param packageManager - The package manager to use (e.g., 'pnpm').
- * @param args - The arguments to pass to the package manager command.
- * @param env - Additional environment variables to set during command execution.
- * @returns A promise that resolves if the command executes successfully; otherwise, it rejects with an error message.
- */
-export async function runPackageManagerCommand(
-  packageManager: string,
-  args: string[],
-  env: Record<string, string> = {}
-): Promise<void> {
-  return new Promise((resolve, reject) => {
-    const child = spawn(packageManager, args, {
-      env: {
-        ...process.env,
-        ...env,
-      },
-      stdio: ['pipe', 'pipe', 'pipe'],
-    });
-
-    // Buffer for capturing stderr and stdout output
-    let stderrBuffer = '';
-    let stdoutBuffer = '';
-
-    // Capture stderr output
-    child.stderr?.on('data', (data: Buffer) => {
-      stderrBuffer += data.toString();
-    });
-
-    // Capture stdout output
-    child.stdout?.on('data', (data: Buffer) => {
-      stdoutBuffer += data.toString();
-    });
-
-    // Handle process exit
-    child.on('close', (code: number | null) => {
-      if (code !== 0) {
-        reject(
-          `"${packageManager} ${args.join(' ')}" failed ${stdoutBuffer} ${stderrBuffer}`
-        );
-        return;
-      }
-      resolve();
-    });
-  });
-}
-
-/**
- * Installs dependencies using the specified package manager.
- * 
- * @param packageManager - The package manager to use for installation (e.g., 'pnpm').
- * @returns A promise that resolves if the installation completes successfully; otherwise, it rejects with an error.
- */
-export async function install(packageManager: string): Promise<void> {
-  return runPackageManagerCommand(packageManager, ['install'], {
-    NODE_ENV: 'development',
-  });
-}
-
-/**
- * Generates SQL files using the specified package manager.
- * 
- * @param packageManager - The package manager to use for generation (e.g., 'pnpm').
- * @returns A promise that resolves if the generation completes successfully; otherwise, it rejects with an error.
- */
-export async function generate(packageManager: string): Promise<void> {
-  return runPackageManagerCommand(packageManager, ['generate'], {
-    NODE_ENV: 'development',
-  });
-}

package/src/utils/validate-project-name.ts

@@ -1,22 +0,0 @@
-import validate from 'validate-npm-package-name';
-
-interface ValidationResult {
-  valid: boolean;
-  problems?: string[];
-}
-
-export function validateProjectName(name: string): ValidationResult {
-  const nameValidation = validate(name);
-
-  if (nameValidation.validForNewPackages) {
-    return { valid: true };
-  }
-
-  return {
-    valid: false,
-    problems: [
-      ...(nameValidation.errors || []),
-      ...(nameValidation.warnings || []),
-    ],
-  };
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-    "extends": "../../tsconfig.json",
-    "compilerOptions": {
-      "allowImportingTsExtensions": true,
-      "noEmit": true,
-      "jsx": "react-jsx",
-      "target": "ESNext",
-      "module": "ESNext",
-
-      "strict": false,
-      "incremental": false,
-      "declaration": true,
-      "composite": false,
-    },
-    "moduleResolution": "Bundler",
-    "include": ["src", "tsup.config.ts"]
-  }