create-react-on-rails-app 16.4.0-rc.6 → 16.4.0-rc.8

package/lib/create-app.d.ts

@@ -1,4 +1,5 @@
 import { CliOptions } from './types.js';
+export declare function buildGeneratorArgs(options: CliOptions): string[];
 export declare function validateAppName(name: string): {
     success: boolean;
     error?: string;

package/lib/create-app.js

@@ -3,12 +3,47 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildGeneratorArgs = buildGeneratorArgs;
 exports.validateAppName = validateAppName;
 exports.createApp = createApp;
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
 const utils_js_1 = require("./utils.js");
-const TOTAL_STEPS = 4;
+function cleanupAppDirectory(appPath, appName, cleanupSuccessMessage, cleanupFallbackMessage) {
+    if (!fs_1.default.existsSync(appPath)) {
+        return;
+    }
+    (0, utils_js_1.logInfo)(`Cleaning up "${appName}" directory...`);
+    try {
+        fs_1.default.rmSync(appPath, { recursive: true, force: true });
+        (0, utils_js_1.logInfo)(cleanupSuccessMessage);
+    }
+    catch {
+        (0, utils_js_1.logError)(cleanupFallbackMessage);
+    }
+}
+function localGemPath(envVarName) {
+    const value = process.env[envVarName];
+    if (!value || value.trim() === '') {
+        return null;
+    }
+    const resolvedPath = path_1.default.resolve(value);
+    if (!fs_1.default.existsSync(resolvedPath)) {
+        (0, utils_js_1.logError)(`Local gem path from ${envVarName} does not exist: ${resolvedPath}`);
+        process.exit(1);
+    }
+    return resolvedPath;
+}
+function bundleAddArgs(gemName, localPath, strict = true) {
+    const args = ['add', gemName];
+    if (localPath) {
+        args.push('--path', localPath);
+    }
+    else if (strict) {
+        args.push('--strict');
+    }
+    return args;
+}
 function buildGeneratorArgs(options) {
     const args = [];
     if (options.template === 'typescript') {
@@ -17,10 +52,13 @@ function buildGeneratorArgs(options) {
     if (options.rspack) {
         args.push('--rspack');
     }
+    if (options.rsc) {
+        args.push('--rsc');
+    }
     args.push('--ignore-warnings');
     return args;
 }
-function printSuccessMessage(appName) {
+function printSuccessMessage(appName, route) {
     console.log('');
     (0, utils_js_1.logSuccess)(`Created ${appName} with React on Rails!`);
     console.log('');
@@ -28,7 +66,7 @@ function printSuccessMessage(appName) {
     console.log(`  cd ${appName}`);
     console.log('  bin/dev');
     console.log('');
-    (0, utils_js_1.logInfo)('Then visit http://localhost:3000/hello_world');
+    (0, utils_js_1.logInfo)(`Then visit http://localhost:3000/${route}`);
     console.log('');
     (0, utils_js_1.logInfo)('Documentation: https://www.shakacode.com/react-on-rails/docs/');
     console.log('');
@@ -37,10 +75,10 @@ function validateAppName(name) {
     if (!name || name.trim() === '') {
         return { success: false, error: 'App name is required.' };
     }
-    if (!/^[a-zA-Z0-9_-]+$/.test(name)) {
+    if (!/^[a-zA-Z][a-zA-Z0-9]*([_-][a-zA-Z0-9]+)*$/.test(name)) {
         return {
             success: false,
-            error: 'App name can only contain letters, numbers, hyphens, and underscores.',
+            error: 'App name must start with a letter, end with a letter or number, and may contain hyphens or underscores only between alphanumeric characters.',
         };
     }
     const appPath = path_1.default.resolve(process.cwd(), name);
@@ -54,10 +92,15 @@ function validateAppName(name) {
 }
 function createApp(appName, options) {
     const appPath = path_1.default.resolve(process.cwd(), appName);
+    const baseSteps = 3; // rails new + add react_on_rails + run generator
+    const totalSteps = baseSteps + (options.rsc ? 1 : 0);
+    let currentStep = 1;
+    const reactOnRailsGemPath = localGemPath('REACT_ON_RAILS_GEM_PATH');
+    const reactOnRailsProGemPath = options.rsc ? localGemPath('REACT_ON_RAILS_PRO_GEM_PATH') : null;
     // Step 1: Create Rails application
-    // appName is validated by validateAppName() to be [a-zA-Z0-9_-]+ only,
+    // appName is validated by validateAppName() to be ^[a-zA-Z][a-zA-Z0-9]*([_-][a-zA-Z0-9]+)*$ only,
     // so it's always a simple directory name safe to use with rails new.
-    (0, utils_js_1.logStep)(1, TOTAL_STEPS, 'Creating Rails application...');
+    (0, utils_js_1.logStep)(currentStep, totalSteps, 'Creating Rails application...');
     try {
         (0, utils_js_1.execLiveArgs)('rails', ['new', appName, '--database=postgresql', '--skip-javascript']);
         (0, utils_js_1.logStepDone)('Rails application created');
@@ -67,12 +110,18 @@ function createApp(appName, options) {
         if (error instanceof Error && error.message) {
             console.error(`Debug info: ${error.message}`);
         }
+        cleanupAppDirectory(appPath, appName, 'Directory removed. Fix the Rails app creation issue and rerun.', `Delete the created "${appName}" directory and rerun once the Rails app creation issue is resolved.`);
         process.exit(1);
     }
     // Step 2: Add react_on_rails gem
-    (0, utils_js_1.logStep)(2, TOTAL_STEPS, 'Adding react_on_rails gem...');
+    currentStep += 1;
+    (0, utils_js_1.logStep)(currentStep, totalSteps, 'Adding react_on_rails gem...');
     try {
-        (0, utils_js_1.execLiveArgs)('bundle', ['add', 'react_on_rails', '--strict'], appPath);
+        const reactOnRailsArgs = bundleAddArgs('react_on_rails', reactOnRailsGemPath);
+        if (reactOnRailsGemPath) {
+            (0, utils_js_1.logInfo)(`Using local react_on_rails gem path: ${reactOnRailsGemPath}`);
+        }
+        (0, utils_js_1.execLiveArgs)('bundle', reactOnRailsArgs, appPath);
         (0, utils_js_1.logStepDone)('react_on_rails gem added');
     }
     catch (error) {
@@ -80,11 +129,33 @@ function createApp(appName, options) {
         if (error instanceof Error && error.message) {
             console.error(`Debug info: ${error.message}`);
         }
+        cleanupAppDirectory(appPath, appName, 'Directory removed. Fix gem installation access or connectivity issues and rerun.', `Delete the created "${appName}" directory and rerun once gem installation issues are resolved.`);
         process.exit(1);
     }
-    // Step 3: Run react_on_rails generator
+    if (options.rsc) {
+        currentStep += 1;
+        (0, utils_js_1.logStep)(currentStep, totalSteps, 'Adding react_on_rails_pro gem (--rsc)...');
+        try {
+            const reactOnRailsProArgs = bundleAddArgs('react_on_rails_pro', reactOnRailsProGemPath, false);
+            if (reactOnRailsProGemPath) {
+                (0, utils_js_1.logInfo)(`Using local react_on_rails_pro gem path: ${reactOnRailsProGemPath}`);
+            }
+            (0, utils_js_1.execLiveArgs)('bundle', reactOnRailsProArgs, appPath);
+            (0, utils_js_1.logStepDone)('react_on_rails_pro gem added');
+        }
+        catch (error) {
+            (0, utils_js_1.logError)('Failed to add react_on_rails_pro gem required by --rsc.');
+            if (error instanceof Error && error.message) {
+                console.error(`Debug info: ${error.message}`);
+            }
+            cleanupAppDirectory(appPath, appName, 'Directory removed. Ensure react_on_rails_pro is installable in your Bundler/RubyGems setup, then rerun with --rsc.', `Ensure react_on_rails_pro is installable, then delete the created "${appName}" directory and rerun with --rsc.`);
+            process.exit(1);
+        }
+    }
+    // Final generator step
     const generatorArgs = buildGeneratorArgs(options);
-    (0, utils_js_1.logStep)(3, TOTAL_STEPS, 'Running React on Rails generator...');
+    currentStep += 1;
+    (0, utils_js_1.logStep)(currentStep, totalSteps, 'Running React on Rails generator...');
     try {
         (0, utils_js_1.execLiveArgs)('bundle', ['exec', 'rails', 'generate', 'react_on_rails:install', ...generatorArgs], appPath);
         (0, utils_js_1.logStepDone)('React on Rails setup complete');
@@ -94,10 +165,11 @@ function createApp(appName, options) {
         if (error instanceof Error && error.message) {
             console.error(`Debug info: ${error.message}`);
         }
+        cleanupAppDirectory(appPath, appName, 'Directory removed. Fix the generator issue and rerun.', `Delete the created "${appName}" directory and rerun once the generator issue is resolved.`);
         process.exit(1);
     }
-    // Step 4: Success
-    (0, utils_js_1.logStep)(4, TOTAL_STEPS, 'Done!');
-    printSuccessMessage(appName);
+    // Final success
+    (0, utils_js_1.logStepDone)('Done!');
+    printSuccessMessage(appName, options.rsc ? 'hello_server' : 'hello_world');
 }
 //# sourceMappingURL=create-app.js.map

package/lib/index.js

@@ -31,6 +31,7 @@ function run(appName, rawOpts) {
         template,
         packageManager: packageManager,
         rspack: Boolean(rawOpts.rspack),
+        rsc: Boolean(rawOpts.rsc),
     };
     console.log('');
     console.log(`${chalk_1.default.bold('create-react-on-rails-app')} v${packageJson.version}`);
@@ -40,6 +41,12 @@ function run(appName, rawOpts) {
         (0, utils_js_1.logError)(nameValidation.error ?? 'Invalid app name');
         process.exit(1);
     }
+    if (options.rsc) {
+        (0, utils_js_1.logInfo)('Note: --rsc installs react_on_rails_pro and requires that gem to be installable.');
+        (0, utils_js_1.logInfo)('If installation fails, verify your Bundler/RubyGems setup for react_on_rails_pro, then rerun with --rsc.');
+        (0, utils_js_1.logInfo)('Pro setup docs: https://www.shakacode.com/react-on-rails-pro/docs/installation/');
+        console.log('');
+    }
     (0, utils_js_1.logInfo)('Checking prerequisites...');
     const { allValid, results } = (0, validators_js_1.validateAll)(options.packageManager);
     for (const { name, result } of results) {
@@ -60,7 +67,7 @@ function run(appName, rawOpts) {
         process.exit(1);
     }
     console.log('');
-    (0, utils_js_1.logInfo)(`Creating "${appName}" with template: ${options.template}, package manager: ${options.packageManager}${options.rspack ? ', bundler: rspack' : ''}`);
+    (0, utils_js_1.logInfo)(`Creating "${appName}" with template: ${options.template}, package manager: ${options.packageManager}${options.rspack ? ', bundler: rspack' : ''}${options.rsc ? ', mode: rsc' : ''}`);
     (0, create_app_js_1.createApp)(appName, options);
 }
 const program = new commander_1.Command();
@@ -74,19 +81,26 @@ program
     .option('-t, --template <type>', 'javascript or typescript', 'typescript')
     .option('-p, --package-manager <pm>', 'npm or pnpm (auto-detected if not specified)')
     .option('--rspack', 'Use Rspack instead of Webpack (~20x faster builds)', false)
+    .option('--rsc', 'Generate React Server Components setup (installs react_on_rails_pro)', false)
     .addHelpText('after', `
 Examples:
   $ npx create-react-on-rails-app my-app
   $ npx create-react-on-rails-app my-app --template javascript
   $ npx create-react-on-rails-app my-app --rspack
+  $ npx create-react-on-rails-app my-app --rsc
+  $ npx create-react-on-rails-app my-app --rspack --rsc
   $ npx create-react-on-rails-app my-app --package-manager pnpm
 
 What it does:
   1. Creates a new Rails app with PostgreSQL
-  2. Adds the react_on_rails gem
+  2. Adds required gem(s) (react_on_rails, plus react_on_rails_pro for --rsc)
   3. Runs the React on Rails generator (Shakapacker, components, webpack config)
 
-After setup, run bin/dev and visit http://localhost:3000/hello_world
+After setup, run bin/dev and visit:
+  - http://localhost:3000/hello_world (default)
+  - http://localhost:3000/hello_server (--rsc)
+
+--rsc supports both JavaScript and TypeScript templates.
 
 Documentation: https://www.shakacode.com/react-on-rails/docs/`)
     .action((appName, opts) => {

package/lib/types.d.ts

@@ -2,6 +2,7 @@ export interface CliOptions {
     template: 'javascript' | 'typescript';
     packageManager: 'npm' | 'pnpm';
     rspack: boolean;
+    rsc: boolean;
 }
 export interface ValidationResult {
     valid: boolean;

package/lib/utils.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Execute a command and stream output to the current terminal.
+ *
+ * Security contract:
+ * - This uses `spawnSync` with `shell: false`, so command and args are passed as literal tokens.
+ * - Callers must still ensure `command` and `args` come from trusted/validated values.
+ */
 export declare function execLiveArgs(command: string, args: string[], cwd?: string): void;
 export declare function getCommandVersion(command: string): string | null;
 export declare function detectPackageManager(): 'npm' | 'pnpm' | null;

package/lib/utils.js

@@ -13,6 +13,13 @@ exports.logSuccess = logSuccess;
 exports.logInfo = logInfo;
 const child_process_1 = require("child_process");
 const chalk_1 = __importDefault(require("chalk"));
+/**
+ * Execute a command and stream output to the current terminal.
+ *
+ * Security contract:
+ * - This uses `spawnSync` with `shell: false`, so command and args are passed as literal tokens.
+ * - Callers must still ensure `command` and `args` come from trusted/validated values.
+ */
 function execLiveArgs(command, args, cwd) {
     const result = (0, child_process_1.spawnSync)(command, args, {
         stdio: 'inherit',

package/lib/validators.js

@@ -9,6 +9,8 @@ const utils_js_1 = require("./utils.js");
 const MIN_NODE_VERSION = 18;
 const MIN_RUBY_MAJOR = 3;
 const MIN_RUBY_MINOR = 0;
+const MIN_RAILS_MAJOR = 7;
+const MIN_RAILS_MINOR = 0;
 function validateNode() {
     const version = process.versions.node;
     const major = parseInt(version.split('.')[0], 10);
@@ -64,7 +66,24 @@ function validateRails() {
                 'Then try again.',
         };
     }
-    return { valid: true, message: railsVersion.split('\n')[0].trim() };
+    const firstLine = railsVersion.split('\n')[0].trim();
+    const match = firstLine.match(/rails\s+(\d+)\.(\d+)/i);
+    if (!match) {
+        return {
+            valid: false,
+            message: `Could not parse Rails version from: "${firstLine}". Please ensure Rails ${MIN_RAILS_MAJOR}.${MIN_RAILS_MINOR}+ is installed.`,
+        };
+    }
+    const major = parseInt(match[1], 10);
+    const minor = parseInt(match[2], 10);
+    // minor check is 0 now; kept for parity with Ruby validator and easy bumping later
+    if (major < MIN_RAILS_MAJOR || (major === MIN_RAILS_MAJOR && minor < MIN_RAILS_MINOR)) {
+        return {
+            valid: false,
+            message: `${firstLine} detected. React on Rails requires Rails ${MIN_RAILS_MAJOR}.${MIN_RAILS_MINOR}+.`,
+        };
+    }
+    return { valid: true, message: firstLine };
 }
 function validatePackageManager(pm) {
     const version = (0, utils_js_1.getCommandVersion)(pm);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-react-on-rails-app",
-  "version": "16.4.0-rc.6",
+  "version": "16.4.0-rc.8",
   "description": "Create React on Rails applications with a single command",
   "bin": {
     "create-react-on-rails-app": "./bin/create-react-on-rails-app.js"
@@ -44,7 +44,7 @@
   "scripts": {
     "build": "pnpm run clean && tsc",
     "build-watch": "pnpm run clean && tsc --watch",
-    "clean": "rm -rf ./lib",
+    "clean": "node -e \"require('fs').rmSync('./lib',{recursive:true,force:true})\"",
     "test": "jest tests",
     "type-check": "tsc --noEmit --noErrorTruncation"
   }