Create React App

// Import from the main createReactApp.js module
const { init, getTemplateInstallPackage } = require("create-react-app/createReactApp");

// Note: The main index.js simply calls init() and is primarily for CLI usage
// Direct module.exports from createReactApp.js:
// { init, getTemplateInstallPackage }

# Create a new React app
npx create-react-app my-app

# Create with TypeScript template
npx create-react-app my-app --template typescript

# Create with custom template
npx create-react-app my-app --template cra-template-pwa

# Show environment information
npx create-react-app --info

# Verbose output
npx create-react-app my-app --verbose

const { init } = require("create-react-app/createReactApp");

// Initialize create-react-app (processes command line arguments)
init();

/**
 * Command-line interface with the following signature:
 * create-react-app <project-directory> [options]
 */
interface CLIOptions {
  /** Project directory name (required) */
  projectDirectory: string;
  /** Print additional logs during creation */
  verbose?: boolean;
  /** Print environment debug information */
  info?: boolean;
  /** Use non-standard version of react-scripts */
  scriptsVersion?: string;
  /** Specify template for the created project */
  template?: string;
  /** Enable Yarn Plug'n'Play (deprecated) */
  usePnp?: boolean;
}

/**
 * Initialize create-react-app CLI processing
 * Reads from process.argv, shows deprecation warning, and executes the app creation workflow
 * Performs version checking against npm registry and warns if outdated
 * Handles --info flag to display environment information
 * Handles --help flag to show usage information
 * @returns {void | Promise<void>} Returns void for synchronous operations, Promise for async operations like environment info display
 */
function init(): void | Promise<void>;

/**
 * Check for latest version of create-react-app on npm registry
 * Falls back to 'npm view create-react-app version' if direct API fails
 * Used internally by init() to warn users of outdated versions
 * @returns {Promise<string|null>} Promise resolving to latest version string or null if unavailable
 */
function checkForLatestVersion(): Promise<string | null>;

/**
 * Resolve template package names for installation
 * Automatically adds 'cra-template-' prefix to template names when needed
 * Handles local paths (file:), URLs, and scoped packages
 * @param {string} [template] - Template name, path, or URL. Defaults to 'cra-template' if not specified
 * @param {string} originalDirectory - Original working directory path for resolving relative file paths
 * @returns {Promise<string>} Promise resolving to installable package name with proper prefixes
 */
function getTemplateInstallPackage(
  template?: string,
  originalDirectory: string
): Promise<string>;

/**
 * Template resolution examples based on actual implementation:
 */
interface TemplateResolution {
  // Input -> Resolved Package Name
  "typescript": "cra-template-typescript";  // Adds prefix to simple names
  "cra-template": "cra-template";           // Preserves existing cra-template prefix
  "cra-template-typescript": "cra-template-typescript"; // No change needed
  "@scope/template": "@scope/cra-template-template";     // Adds prefix to scoped packages
  "@scope/cra-template": "@scope/cra-template";          // Preserves existing prefix in scoped packages
  "@scope/cra-template-typescript": "@scope/cra-template-typescript"; // No change for complete scoped names
  "file:../my-template": "file:/absolute/path/to/my-template"; // Resolves relative file paths to absolute
  "https://example.com/template.tgz": "https://example.com/template.tgz"; // URLs and archives pass through unchanged
  "my-template.tar.gz": "my-template.tar.gz"; // Archive files pass through unchanged
  "@next": "@next/cra-template";              // Version-only input gets default template name
}

my-app/
├── public/
│   ├── index.html
│   └── manifest.json
├── src/
│   ├── App.js
│   ├── App.test.js
│   ├── index.js
│   └── index.css
├── package.json
└── README.md

interface SystemRequirements {
  /** Minimum Node.js version */
  nodeVersion: ">=14.0.0";
  /** Supported package managers */
  packageManagers: ["npm", "yarn"];
  /** Minimum npm version for full feature support */
  npmVersion: ">=6.0.0";
  /** Minimum Yarn version for PnP support (deprecated) */
  yarnPnpVersion: ">=1.12.0";
}

interface ProjectDependencies {
  /** Core React library */
  react: string;
  /** React DOM rendering */
  "react-dom": string;
  /** Build scripts and development server */
  "react-scripts": string;
  /** Optional: Template-specific dependencies */
  [templateDependency: string]: string;
}