@react-native-harness/cli 1.0.0-alpha.23 → 1.0.0-alpha.25

package/src/wizard/configGenerator.ts

@@ -0,0 +1,139 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import type { RunTarget } from '@react-native-harness/platforms';
+import type { ProjectConfig } from './projectType.js';
+
+const q = (s: string) => `'${s.replace(/'/g, "\\'")}'`;
+
+const getDeviceCall = (target: RunTarget): string => {
+  const { device, type, platform } = target;
+  if (platform === 'android') {
+    if (type === 'emulator') {
+      return `androidEmulator(${q(device.name)})`;
+    }
+    return `physicalAndroidDevice(${q(device.manufacturer)}, ${q(
+      device.model
+    )})`;
+  }
+  if (platform === 'ios') {
+    if (type === 'emulator') {
+      return `appleSimulator(${q(device.name)}, ${q(device.systemVersion)})`;
+    }
+    return `applePhysicalDevice(${q(device.name)})`;
+  }
+  return JSON.stringify(device);
+};
+
+const getPlatformFn = (platform: string): string => {
+  if (platform === 'android') return 'androidPlatform';
+  if (platform === 'ios') return 'applePlatform';
+  return `${platform}Platform`;
+};
+
+export const generateConfig = (
+  projectConfig: ProjectConfig,
+  selectedPlatforms: string[],
+  selectedTargets: RunTarget[],
+  bundleIds: Record<string, string>
+) => {
+  const imports: string[] = [];
+  if (selectedPlatforms.includes('android')) {
+    const androidFactories = ['androidPlatform'];
+    if (
+      selectedTargets.some(
+        (t) => t.platform === 'android' && t.type === 'emulator'
+      )
+    )
+      androidFactories.push('androidEmulator');
+    if (
+      selectedTargets.some(
+        (t) => t.platform === 'android' && t.type === 'physical'
+      )
+    )
+      androidFactories.push('physicalAndroidDevice');
+
+    imports.push(
+      `import { ${androidFactories.join(
+        ', '
+      )} } from "@react-native-harness/platform-android";`
+    );
+  }
+  if (selectedPlatforms.includes('ios')) {
+    const iosFactories = ['applePlatform'];
+    if (
+      selectedTargets.some((t) => t.platform === 'ios' && t.type === 'emulator')
+    )
+      iosFactories.push('appleSimulator');
+    if (
+      selectedTargets.some((t) => t.platform === 'ios' && t.type === 'physical')
+    )
+      iosFactories.push('applePhysicalDevice');
+
+    imports.push(
+      `import { ${iosFactories.join(
+        ', '
+      )} } from "@react-native-harness/platform-apple";`
+    );
+  }
+  if (selectedPlatforms.includes('web')) {
+    const webFactories = ['webPlatform'];
+    const browsers = new Set(
+      selectedTargets
+        .filter((t) => t.platform === 'web')
+        .map((t) => t.device.browserType)
+    );
+    for (const browser of browsers) {
+      if (browser) webFactories.push(browser);
+    }
+
+    imports.push(
+      `import { ${webFactories.join(
+        ', '
+      )} } from "@react-native-harness/platform-web";`
+    );
+  }
+
+  const runnerConfigs = selectedTargets.map((target) => {
+    const platformFn = getPlatformFn(target.platform);
+    const name = target.name.toLowerCase().replace(/\s+/g, '-');
+
+    if (target.platform === 'web') {
+      const url = bundleIds[target.platform];
+      const browserCall = `${target.device.browserType}(${q(url)})`;
+      return `    ${platformFn}({
+      name: ${q(name)},
+      browser: ${browserCall},
+    }),`;
+    }
+
+    const bundleId = bundleIds[target.platform];
+    const deviceCall = getDeviceCall(target);
+
+    return `    ${platformFn}({
+      name: ${q(name)},
+      device: ${deviceCall},
+      bundleId: ${q(bundleId)},
+    }),`;
+  });
+
+  const configContent = `
+${imports.join('\n')}
+
+export default {
+  entryPoint: ${q(projectConfig.entryPoint)},
+  appRegistryComponentName: ${q(projectConfig.appRegistryComponentName)},
+
+  runners: [
+${runnerConfigs.join('\n')}
+  ],
+  defaultRunner: ${q(
+    selectedTargets[0].name.toLowerCase().replace(/\s+/g, '-')
+  )},
+};
+`;
+
+  fs.writeFileSync(
+    path.join(process.cwd(), 'rn-harness.config.mjs'),
+    configContent.trim() + '\n'
+  );
+};

package/src/wizard/index.ts

@@ -0,0 +1,72 @@
+import {
+  intro,
+  outro,
+  note,
+  isProject,
+  cancelPromptAndExit,
+  promptConfirm,
+} from '@react-native-harness/tools';
+import { getProjectConfig } from './projectType.js';
+import { installPlatforms } from './platforms.js';
+import { discoverTargets } from './targets.js';
+import { getBundleIds } from './bundleId.js';
+import { generateConfig } from './configGenerator.js';
+import { createJestConfig } from './jestConfig.js';
+import fs from 'node:fs';
+import path from 'node:path';
+
+const CONFIG_EXTENSIONS = ['.js', '.mjs', '.cjs', '.json'];
+
+const checkForExistingConfig = async (projectRoot: string) => {
+  const existingConfig = CONFIG_EXTENSIONS.find((ext) =>
+    fs.existsSync(path.join(projectRoot, `rn-harness.config${ext}`))
+  );
+
+  if (existingConfig) {
+    const shouldOverwrite = await promptConfirm({
+      message: `A configuration file (rn-harness.config${existingConfig}) already exists. Are you sure you want to overwrite it?`,
+      confirmLabel: 'Overwrite',
+      cancelLabel: 'Keep existing',
+    });
+
+    if (!shouldOverwrite) {
+      cancelPromptAndExit('Setup cancelled. Keeping existing configuration.');
+    }
+  }
+};
+
+export const runInitWizard = async () => {
+  const projectRoot = process.cwd();
+
+  if (!isProject(projectRoot)) {
+    cancelPromptAndExit(
+      'React Native Harness must be run in a React Native project root (directory with package.json containing react-native).'
+    );
+  }
+
+  intro('React Native Harness');
+
+  note(
+    "This wizard will guide you through the setup process to get React Native Harness up and running in your project. We'll help you configure your project type, platforms, and test targets.",
+    'Configuration wizard'
+  );
+
+  await checkForExistingConfig(projectRoot);
+
+  const projectConfig = await getProjectConfig();
+  const selectedPlatforms = await installPlatforms();
+  const selectedTargets = await discoverTargets(selectedPlatforms);
+  const bundleIds = await getBundleIds(selectedPlatforms);
+
+  generateConfig(projectConfig, selectedPlatforms, selectedTargets, bundleIds);
+  await createJestConfig(projectRoot);
+
+  note(
+    'A dedicated Jest configuration (jest.harness.config.mjs) has been created. Harness will automatically use it when you run the "harness" command.',
+    'Jest configuration'
+  );
+
+  outro(
+    'Setup complete. Happy testing!'
+  );
+};

package/src/wizard/jestConfig.ts

@@ -0,0 +1,28 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { promptConfirm } from '@react-native-harness/tools';
+
+export const createJestConfig = async (projectRoot: string) => {
+  const configPath = path.join(projectRoot, 'jest.harness.config.mjs');
+
+  if (fs.existsSync(configPath)) {
+    const shouldOverwrite = await promptConfirm({
+      message:
+        'A dedicated Jest configuration (jest.harness.config.mjs) already exists. Do you want to overwrite it?',
+      confirmLabel: 'Overwrite',
+      cancelLabel: 'Keep existing',
+    });
+
+    if (!shouldOverwrite) {
+      return;
+    }
+  }
+
+  const configContent = `export default {
+  preset: 'react-native-harness',
+  testMatch: ['<rootDir>/**/__tests__/**/*.harness.[jt]s?(x)'],
+};
+`;
+
+  fs.writeFileSync(configPath, configContent);
+};

package/src/wizard/platforms.ts

@@ -0,0 +1,44 @@
+import {
+  promptMultiselect,
+  spinner,
+  cancelPromptAndExit,
+  installDevDependency,
+} from '@react-native-harness/tools';
+
+export const installPlatforms = async (): Promise<string[]> => {
+  const projectRoot = process.cwd();
+  const selectedPlatforms = await promptMultiselect({
+    message: 'Select platforms to support',
+    options: [
+      { value: 'android', label: 'Android' },
+      { value: 'ios', label: 'iOS' },
+      { value: 'web', label: 'Web' },
+    ],
+  });
+
+  if (selectedPlatforms.length === 0) {
+    cancelPromptAndExit('At least one platform must be selected.');
+  }
+
+  const installSpinner = spinner();
+  installSpinner.start('Installing platform packages...');
+
+  const packagesToInstall: string[] = [];
+  if (selectedPlatforms.includes('android'))
+    packagesToInstall.push('@react-native-harness/platform-android');
+  if (selectedPlatforms.includes('ios'))
+    packagesToInstall.push('@react-native-harness/platform-apple');
+  if (selectedPlatforms.includes('web'))
+    packagesToInstall.push('@react-native-harness/platform-web');
+
+  try {
+    await installDevDependency(projectRoot, packagesToInstall);
+    installSpinner.stop('Platform packages installed successfully.');
+  } catch (error) {
+    installSpinner.stop('Failed to install platform packages.', 1);
+    console.error(error);
+    process.exit(1);
+  }
+
+  return selectedPlatforms as string[];
+};

package/src/wizard/projectType.ts

@@ -0,0 +1,77 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { promptSelect, promptText } from '@react-native-harness/tools';
+
+export type ProjectConfig = {
+  entryPoint: string;
+  appRegistryComponentName: string;
+};
+
+const tryExtractComponentName = (entryPoint: string): string | undefined => {
+  try {
+    const filePath = path.resolve(process.cwd(), entryPoint);
+    if (!fs.existsSync(filePath)) return undefined;
+
+    const content = fs.readFileSync(filePath, 'utf8');
+    // Look for AppRegistry.registerComponent('Name', ...) or AppRegistry.registerComponent("Name", ...)
+    const match = content.match(
+      /AppRegistry\.registerComponent\(\s*['"](.+?)['"]/
+    );
+
+    return match ? match[1] : undefined;
+  } catch {
+    return undefined;
+  }
+};
+
+export const getProjectConfig = async (): Promise<ProjectConfig> => {
+  const projectType = await promptSelect({
+    message: 'What type of project is this?',
+    options: [
+      { value: 'expo', label: 'Expo' },
+      { value: 'custom', label: 'React Native CLI / Custom' },
+    ],
+  });
+
+  if (projectType === 'expo') {
+    try {
+      const packageJson = JSON.parse(
+        fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8')
+      );
+      return {
+        entryPoint: packageJson.main || './node_modules/expo/AppEntry.js',
+        appRegistryComponentName: 'main',
+      };
+    } catch {
+      return {
+        entryPoint: './node_modules/expo/AppEntry.js',
+        appRegistryComponentName: 'main',
+      };
+    }
+  }
+
+  const entryPoint = await promptText({
+    message: 'Enter the path to your app entry file',
+    initialValue: './index.js',
+    placeholder: './index.js',
+    validate: (value: string | undefined) => {
+      if (!value) return 'Entry point is required';
+      return;
+    },
+  });
+
+  const suggestedComponentName = tryExtractComponentName(entryPoint);
+
+  const appRegistryComponentName = await promptText({
+    message:
+      'Enter the name of the component registered via AppRegistry.registerComponent()',
+    placeholder: 'MyAppName',
+    initialValue: suggestedComponentName,
+    validate: (value: string | undefined) => {
+      if (!value) return 'Component name is required';
+      return;
+    },
+  });
+
+  return { entryPoint, appRegistryComponentName };
+};

package/src/wizard/targets.ts

@@ -0,0 +1,78 @@
+import {
+  spinner,
+  promptAutocompleteMultiselect,
+  cancelPromptAndExit,
+} from '@react-native-harness/tools';
+import type { RunTarget } from '@react-native-harness/platforms';
+
+export const discoverTargets = async (
+  selectedPlatforms: string[]
+): Promise<RunTarget[]> => {
+  const allTargets: RunTarget[] = [];
+  const targetSpinner = spinner();
+  targetSpinner.start('Discovering available targets...');
+
+  if (selectedPlatforms.includes('android')) {
+    try {
+      const androidPlatform = await import(
+        '@react-native-harness/platform-android'
+      );
+      const targets: RunTarget[] = await androidPlatform.getRunTargets();
+      allTargets.push(...targets);
+    } catch (e) {
+      console.error('Failed to load Android targets:', e);
+    }
+  }
+
+  if (selectedPlatforms.includes('ios')) {
+    try {
+      const applePlatform = await import(
+        '@react-native-harness/platform-apple'
+      );
+      const targets: RunTarget[] = await applePlatform.getRunTargets();
+      allTargets.push(...targets);
+    } catch (e) {
+      console.error('Failed to load iOS targets:', e);
+    }
+  }
+
+  if (selectedPlatforms.includes('web')) {
+    try {
+      const webPlatform = await import('@react-native-harness/platform-web');
+      const targets: RunTarget[] = await webPlatform.getRunTargets();
+      allTargets.push(...targets);
+    } catch (e) {
+      console.error('Failed to load Web targets:', e);
+    }
+  }
+
+  targetSpinner.stop('Target discovery complete.');
+
+  if (allTargets.length === 0) {
+    cancelPromptAndExit('No available targets (emulators or devices) found.');
+  }
+
+  const options = allTargets.map((target, index) => {
+    let platformLabel = 'Unknown';
+    if (target.platform === 'android') platformLabel = 'Android';
+    else if (target.platform === 'ios') platformLabel = 'iOS';
+    else if (target.platform === 'web') platformLabel = 'Web';
+
+    return {
+      value: index,
+      label: `[${platformLabel}] ${target.name} (${target.type})`,
+      hint: target.description,
+    };
+  });
+
+  const selectedTargetIndices = await promptAutocompleteMultiselect<number>({
+    message: 'Select targets to support in Harness',
+    options,
+  });
+
+  if (selectedTargetIndices.length === 0) {
+    cancelPromptAndExit('At least one target must be selected.');
+  }
+
+  return selectedTargetIndices.map((i) => allTargets[i]);
+};

package/tsconfig.json

@@ -3,12 +3,27 @@
   "files": [],
   "include": [],
   "references": [
+    {
+      "path": "../platform-web"
+    },
+    {
+      "path": "../tools"
+    },
+    {
+      "path": "../platforms"
+    },
     {
       "path": "../config"
     },
     {
       "path": "../bridge"
     },
+    {
+      "path": "../platform-ios"
+    },
+    {
+      "path": "../platform-android"
+    },
     {
       "path": "./tsconfig.lib.json"
     }

package/tsconfig.lib.json

@@ -12,11 +12,26 @@
   },
   "include": ["src/**/*.ts"],
   "references": [
+    {
+      "path": "../platform-web/tsconfig.lib.json"
+    },
+    {
+      "path": "../tools/tsconfig.lib.json"
+    },
+    {
+      "path": "../platforms/tsconfig.lib.json"
+    },
     {
       "path": "../config/tsconfig.lib.json"
     },
     {
       "path": "../bridge/tsconfig.lib.json"
+    },
+    {
+      "path": "../platform-ios/tsconfig.lib.json"
+    },
+    {
+      "path": "../platform-android/tsconfig.lib.json"
     }
   ]
 }