optikit 1.1.1 → 1.2.1

package/src/commands/project/open.ts

@@ -0,0 +1,193 @@
+import { LoggerHelpers } from "../../utils/services/logger.js";
+import { execCommand } from "../../utils/services/exec.js";
+import { platform } from "os";
+import { validateFlutterProject, validateIosProject, validateAndroidProject } from "../../utils/validators/validation.js";
+import * as fs from "fs";
+import * as path from "path";
+
+export { openIos, openAndroid, openIpaOutput, openBundleOutput, openApkOutput };
+
+async function openIos() {
+  LoggerHelpers.info("Opening the iOS project in Xcode...");
+
+  // Pre-flight validation
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  if (!validateIosProject()) {
+    process.exit(1);
+  }
+
+  const command = "open ios/Runner.xcworkspace";
+
+  try {
+    await execCommand(command);
+    LoggerHelpers.success("Xcode opened successfully.");
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error while opening Xcode: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error while opening Xcode: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+async function openAndroid() {
+    LoggerHelpers.info("Opening the Android project in Android Studio...");
+
+    // Pre-flight validation
+    if (!validateFlutterProject()) {
+      process.exit(1);
+    }
+
+    if (!validateAndroidProject()) {
+      process.exit(1);
+    }
+
+    const osPlatform = platform();
+    let command;
+
+
+    if (osPlatform === "win32") {
+      command = "start android";
+    } else if (osPlatform === "darwin") {
+      command = "open -a 'Android Studio' android";
+    } else {
+      command = "xdg-open android";
+    }
+
+    try {
+      await execCommand(command);
+      LoggerHelpers.success("Android Studio opened successfully.");
+    } catch (error) {
+      if (error instanceof Error) {
+        LoggerHelpers.error(
+          `Error while opening Android Studio: ${error.message}`
+        );
+      } else {
+        LoggerHelpers.error(`Error while opening Android Studio: ${error}`);
+      }
+      process.exit(1);
+    }
+}
+
+/**
+ * Opens the IPA build output directory in Finder (macOS) or File Explorer (Windows/Linux)
+ */
+async function openIpaOutput(): Promise<void> {
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  const ipaPath = path.join(process.cwd(), "build", "ios", "ipa");
+
+  if (!fs.existsSync(ipaPath)) {
+    LoggerHelpers.warning(`IPA output directory not found: ${ipaPath}`);
+    LoggerHelpers.info("Build an IPA first using: optikit flutter-build-ipa");
+    process.exit(1);
+  }
+
+  try {
+    const openCommand = getOpenCommand();
+    await execCommand(`${openCommand} "${ipaPath}"`);
+    LoggerHelpers.success(`Opened IPA output directory`);
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error opening IPA directory: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error opening IPA directory: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Opens the Android App Bundle output directory in Finder (macOS) or File Explorer (Windows/Linux)
+ */
+async function openBundleOutput(): Promise<void> {
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  const bundlePath = path.join(
+    process.cwd(),
+    "build",
+    "app",
+    "outputs",
+    "bundle",
+    "release"
+  );
+
+  if (!fs.existsSync(bundlePath)) {
+    LoggerHelpers.warning(`Bundle output directory not found: ${bundlePath}`);
+    LoggerHelpers.info("Build a bundle first using: optikit flutter-build-bundle");
+    process.exit(1);
+  }
+
+  try {
+    const openCommand = getOpenCommand();
+    await execCommand(`${openCommand} "${bundlePath}"`);
+    LoggerHelpers.success(`Opened Bundle output directory`);
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error opening Bundle directory: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error opening Bundle directory: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Opens the APK build output directory in Finder (macOS) or File Explorer (Windows/Linux)
+ */
+async function openApkOutput(): Promise<void> {
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  const apkPath = path.join(
+    process.cwd(),
+    "build",
+    "app",
+    "outputs",
+    "flutter-apk"
+  );
+
+  if (!fs.existsSync(apkPath)) {
+    LoggerHelpers.warning(`APK output directory not found: ${apkPath}`);
+    LoggerHelpers.info("Build an APK first using: optikit flutter-build-apk");
+    process.exit(1);
+  }
+
+  try {
+    const openCommand = getOpenCommand();
+    await execCommand(`${openCommand} "${apkPath}"`);
+    LoggerHelpers.success(`Opened APK output directory`);
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error opening APK directory: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error opening APK directory: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Returns the appropriate command to open a directory based on the platform
+ */
+function getOpenCommand(): string {
+  const osPlatform = platform();
+
+  switch (osPlatform) {
+    case "darwin": // macOS
+      return "open";
+    case "win32": // Windows
+      return "start";
+    default: // Linux and others
+      return "xdg-open";
+  }
+}

package/src/commands/project/setup.ts

@@ -0,0 +1,50 @@
+import fs from "fs";
+import path from "path";
+import { LoggerHelpers } from "../../utils/services/logger.js";
+
+export {
+  createVscodeSettings,
+};
+
+/**
+ * Creates a .vscode directory (if it doesn't exist) and writes a settings.json file
+ * with recommended Flutter configuration. The Flutter SDK path is set to ".fvm/flutter_sdk".
+ */
+async function createVscodeSettings(){
+  try {
+    const vscodeDir = path.join(process.cwd(), ".vscode");
+    const settingsPath = path.join(vscodeDir, "settings.json");
+
+    // Create the .vscode folder using Node.js fs (cross-platform)
+    if (!fs.existsSync(vscodeDir)) {
+      fs.mkdirSync(vscodeDir, { recursive: true });
+      LoggerHelpers.success("Created .vscode directory.");
+    } else {
+      LoggerHelpers.info(".vscode directory already exists.");
+    }
+
+    // Define the settings object
+    const settings = {
+      "dart.flutterSdkPath": ".fvm/flutter_sdk",
+      "editor.formatOnSave": true,
+      "dart.previewFlutterUiGuides": true,
+      "files.exclude": {
+        "**/.git": true,
+        "**/.DS_Store": true,
+        "**/node_modules": true,
+        "**/build": true
+      }
+    };
+
+    // Write settings.json using Node.js fs
+    fs.writeFileSync(settingsPath, JSON.stringify(settings, null, 2), "utf8");
+    LoggerHelpers.success("Created .vscode/settings.json with Flutter configuration.");
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error while creating VSCode settings: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error while creating VSCode settings: ${error}`);
+    }
+    process.exit(1);
+  }
+} 

package/src/commands/version/bump.ts

@@ -0,0 +1,202 @@
+import { validateFlutterProject } from "../../utils/validators/validation.js";
+import { LoggerHelpers } from "../../utils/services/logger.js";
+import {
+  getCurrentVersion,
+  incrementVersion,
+  formatVersion,
+  getNextBuildNumber
+} from "../../utils/helpers/version.js";
+import { updateFlutterVersion } from "./update.js";
+import chalk from "chalk";
+
+export {
+  bumpVersion,
+  bumpIosBuildOnly,
+  bumpAndroidBuildOnly,
+  showCurrentVersion
+};
+
+/**
+ * Bumps version with semantic versioning (major, minor, patch)
+ * Android build number increments with version
+ * iOS build number resets to 1 on version change
+ *
+ * @param type - Type of version bump (major, minor, patch)
+ */
+async function bumpVersion(
+  type: 'major' | 'minor' | 'patch'
+): Promise<void> {
+  // Pre-flight validation
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  try {
+    const current = getCurrentVersion();
+    const newVersion = incrementVersion(current, type);
+
+    LoggerHelpers.info(`Current version: ${formatVersion(current)}`);
+    LoggerHelpers.info(`Bumping ${type} version...`);
+
+    console.log(chalk.cyan("\nVersion changes:"));
+    console.log(chalk.gray("  Old:"), chalk.white(formatVersion(current)));
+    console.log(chalk.gray("  New:"), chalk.green.bold(formatVersion(newVersion)));
+
+    console.log(chalk.cyan("\nBuild number strategy:"));
+    console.log(chalk.gray("  Android:"), chalk.white(`${current.buildNumber} → ${newVersion.buildNumber} (incremented)`));
+    console.log(chalk.gray("  iOS:"), chalk.white(`${current.buildNumber} → 1 (reset for new version)`));
+    console.log();
+
+    // Update with new version
+    // Android uses the incremented build number from version
+    // iOS gets reset to 1 for new version releases
+    await updateFlutterVersion(
+      `${newVersion.major}.${newVersion.minor}.${newVersion.patch}`,
+      newVersion.buildNumber.toString(),
+      "1"  // iOS always starts at 1 for new versions
+    );
+
+    LoggerHelpers.success(`Version bumped to ${formatVersion(newVersion)}`);
+    console.log(chalk.gray("\nAndroid build:"), chalk.white(newVersion.buildNumber));
+    console.log(chalk.gray("iOS build:"), chalk.white("1"));
+
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error bumping version: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error bumping version: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Increments ONLY iOS build number (for TestFlight builds)
+ * Keeps version and Android build number unchanged
+ * Perfect for uploading new iOS builds without changing app version
+ *
+ * Example: 1.0.2+45 (iOS: 45) → 1.0.2+45 (iOS: 46)
+ */
+async function bumpIosBuildOnly(): Promise<void> {
+  // Pre-flight validation
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  try {
+    const current = getCurrentVersion();
+    const currentVersionString = `${current.major}.${current.minor}.${current.patch}`;
+
+    // iOS build number increments from current Android build number
+    const nextIosBuild = current.buildNumber + 1;
+
+    LoggerHelpers.info(`Current version: ${formatVersion(current)}`);
+    LoggerHelpers.info("Incrementing iOS build number only (for TestFlight)...");
+
+    console.log(chalk.cyan("\nBuild number changes:"));
+    console.log(chalk.gray("  Version:"), chalk.white(`${currentVersionString} (unchanged)`));
+    console.log(chalk.gray("  Android:"), chalk.white(`${current.buildNumber} (unchanged)`));
+    console.log(chalk.gray("  iOS:"), chalk.white(`${current.buildNumber} → ${nextIosBuild}`), chalk.green("(incremented)"));
+    console.log();
+
+    // Update only iOS build number
+    await updateFlutterVersion(
+      currentVersionString,
+      "",  // Empty string means don't update Android
+      nextIosBuild.toString()
+    );
+
+    LoggerHelpers.success(`iOS build number incremented to ${nextIosBuild}`);
+    console.log(chalk.gray("\nResult:"), chalk.white(`${currentVersionString}+${current.buildNumber} (iOS: ${nextIosBuild})`));
+    console.log(chalk.gray("Use this for:"), chalk.white("TestFlight uploads without version changes"));
+
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error incrementing iOS build: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error incrementing iOS build: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Increments ONLY Android build number
+ * Keeps version and iOS build number unchanged
+ */
+async function bumpAndroidBuildOnly(): Promise<void> {
+  // Pre-flight validation
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
+  try {
+    const current = getCurrentVersion();
+    const currentVersionString = `${current.major}.${current.minor}.${current.patch}`;
+    const nextAndroidBuild = current.buildNumber + 1;
+
+    LoggerHelpers.info(`Current version: ${formatVersion(current)}`);
+    LoggerHelpers.info("Incrementing Android build number only...");
+
+    console.log(chalk.cyan("\nBuild number changes:"));
+    console.log(chalk.gray("  Version:"), chalk.white(`${currentVersionString} (unchanged)`));
+    console.log(chalk.gray("  Android:"), chalk.white(`${current.buildNumber} → ${nextAndroidBuild}`), chalk.green("(incremented)"));
+    console.log(chalk.gray("  iOS:"), chalk.white("(unchanged)"));
+    console.log();
+
+    // Update only Android build number
+    await updateFlutterVersion(
+      currentVersionString,
+      nextAndroidBuild.toString(),
+      ""  // Empty string means don't update iOS
+    );
+
+    LoggerHelpers.success(`Android build number incremented to ${nextAndroidBuild}`);
+
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error incrementing Android build: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error incrementing Android build: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Shows current version information
+ */
+async function showCurrentVersion(): Promise<void> {
+  try {
+    const current = getCurrentVersion();
+    const versionString = formatVersion(current);
+
+    console.log(chalk.bold("\n📱 Current Version Information\n"));
+    console.log(chalk.cyan("Version:"), chalk.white.bold(versionString));
+    console.log(chalk.gray("  Major:"), chalk.white(current.major));
+    console.log(chalk.gray("  Minor:"), chalk.white(current.minor));
+    console.log(chalk.gray("  Patch:"), chalk.white(current.patch));
+    console.log(chalk.gray("  Build:"), chalk.white(current.buildNumber));
+    console.log();
+
+  } catch (error) {
+    if (error instanceof Error) {
+      LoggerHelpers.error(`Error reading version: ${error.message}`);
+    } else {
+      LoggerHelpers.error(`Error reading version: ${error}`);
+    }
+    process.exit(1);
+  }
+}
+
+/**
+ * Helper to get next iOS build number
+ * In the future, this could read from Info.plist or project.pbxproj
+ * For now, we'll use a simple increment
+ */
+async function getNextIosBuildNumber(): Promise<number> {
+  // TODO: Read actual iOS build number from Info.plist or project.pbxproj
+  // For now, we'll just increment based on timestamp or simple counter
+  const current = getCurrentVersion();
+  return current.buildNumber + 1;
+}

package/src/commands/{updateVersions.ts → version/update.ts}

@@ -1,7 +1,9 @@
 import fs from "fs";
 import path from "path";
-import { execInIos } from "../utils/execHelpers.js";
-import { LoggerHelpers } from "../utils/loggerHelpers.js";
+import { execInIos } from "../../utils/services/exec.js";
+import { LoggerHelpers } from "../../utils/services/logger.js";
+import { validateFlutterProject } from "../../utils/validators/validation.js";
+import { createBackup } from "../../utils/services/backup.js";
 
 const currentDir = process.cwd();
 
@@ -12,6 +14,11 @@ async function updateFlutterVersion(
   build: string,
   iosBuild: string
 ) {
+  // Pre-flight validation
+  if (!validateFlutterProject()) {
+    process.exit(1);
+  }
+
   try {
     // Always update the version since it is required.
     LoggerHelpers.info(`Starting update for version ${version}...`);
@@ -43,7 +50,7 @@ async function updateFlutterVersion(
         error instanceof Error ? error.message : String(error)
       }`
     );
-    throw error;
+    process.exit(1);
   }
 }
 
@@ -55,6 +62,9 @@ async function updatePubspecVersionAndBuild(version: string, build: string) {
       throw new Error(`pubspec.yaml not found at ${pubspecPath}`);
     }
 
+    // Create backup before modification
+    createBackup(pubspecPath);
+
     const pubspecContent = fs.readFileSync(pubspecPath, "utf8");
 
     const updatedPubspec = pubspecContent.replace(
@@ -80,13 +90,16 @@ async function updatePubspecVersionAndBuild(version: string, build: string) {
 async function updateIosVersionAndBuild(version: string, iosBuild: string) {
     try {
       const currentDir = process.cwd();
-  
+
       const projectPbxProjPath = path.join(currentDir, "ios/Runner.xcodeproj/project.pbxproj");
-  
+
       if (!fs.existsSync(projectPbxProjPath)) {
         throw new Error(`project.pbxproj not found at ${projectPbxProjPath}`);
       }
-  
+
+      // Create backup before modification
+      createBackup(projectPbxProjPath);
+
       let projectContent = fs.readFileSync(projectPbxProjPath, 'utf8');
   
       projectContent = projectContent
@@ -109,6 +122,9 @@ async function updateIosVersionAndBuild(version: string, iosBuild: string) {
         throw new Error(`Info.plist not found at ${infoPlistPath}`);
       }
 
+      // Create backup before modification
+      createBackup(infoPlistPath);
+
       const infoPlistContent = fs.readFileSync(infoPlistPath, "utf8");
 
       const updatedPlist = infoPlistContent

package/src/constants.ts

@@ -0,0 +1,144 @@
+/**
+ * Application-wide constants
+ */
+
+// Build configurations
+export const BUILD_CONFIGS = {
+  APK: {
+    outputPath: "build/app/outputs/symbols",
+    flags: ["--release", "--obfuscate"],
+  },
+  BUNDLE: {
+    outputPath: "build/app/outputs/symbols",
+    flags: ["--release", "--obfuscate"],
+  },
+  IOS: {
+    flags: ["--release"],
+  },
+  IPA: {
+    flags: ["--release"],
+  },
+} as const;
+
+// Project structure
+export const PROJECT_PATHS = {
+  PUBSPEC: "pubspec.yaml",
+  PUBSPEC_LOCK: "pubspec.lock",
+  IOS_DIR: "ios",
+  ANDROID_DIR: "android",
+  LIB_DIR: "lib",
+  MODULE_DIR: "lib/module",
+  IOS_RUNNER_PROJ: "ios/Runner.xcodeproj",
+  IOS_RUNNER_WORKSPACE: "ios/Runner.xcworkspace",
+  IOS_PROJECT_PBXPROJ: "ios/Runner.xcodeproj/project.pbxproj",
+  IOS_INFO_PLIST: "ios/Runner/Info.plist",
+  IOS_PODFILE_LOCK: "ios/Podfile.lock",
+  ANDROID_BUILD_GRADLE: "android/build.gradle",
+  ANDROID_BUILD_GRADLE_KTS: "android/build.gradle.kts",
+  FVM_FLUTTER_SDK: ".fvm/flutter_sdk",
+  VSCODE_DIR: ".vscode",
+  VSCODE_SETTINGS: ".vscode/settings.json",
+} as const;
+
+// Backup configuration
+export const BACKUP_CONFIG = {
+  DIR_NAME: ".optikit-backup",
+  RETENTION_COUNT: 5,
+} as const;
+
+// Module generation
+export const MODULE_STRUCTURE = {
+  DIRECTORIES: ["bloc", "event", "state", "screen", "import", "factory"],
+  NAME_PATTERN: /^[a-z0-9_]+$/,
+} as const;
+
+// Flutter commands
+export const FLUTTER_COMMANDS = {
+  CLEAN: "flutter clean",
+  PUB_GET: "flutter pub get",
+  BUILD_APK: "flutter build apk",
+  BUILD_BUNDLE: "flutter build appbundle",
+  BUILD_IOS: "flutter build ios",
+  BUILD_IPA: "flutter build ipa",
+  PRECACHE_IOS: "flutter precache --ios",
+  VERSION: "flutter --version",
+} as const;
+
+// FVM commands
+export const FVM_COMMANDS = {
+  CLEAN: "fvm flutter clean",
+  PUB_GET: "fvm flutter pub get",
+  BUILD_APK: "fvm flutter build apk",
+  BUILD_BUNDLE: "fvm flutter build appbundle",
+  BUILD_IOS: "fvm flutter build ios",
+  BUILD_IPA: "fvm flutter build ipa",
+  PRECACHE_IOS: "fvm flutter precache --ios",
+  VERSION: "fvm --version",
+} as const;
+
+// iOS commands
+export const IOS_COMMANDS = {
+  POD_DEINTEGRATE: "pod deintegrate",
+  POD_INSTALL: "pod install",
+  POD_UPDATE: "pod update",
+  POD_REPO_UPDATE: "pod repo update",
+  POD_CACHE_CLEAN: "pod cache clean --all",
+} as const;
+
+// IDE commands
+export const IDE_COMMANDS = {
+  XCODE: "open ios/Runner.xcworkspace",
+  ANDROID_STUDIO: {
+    DARWIN: "open -a 'Android Studio' android",
+    WIN32: "start android",
+    LINUX: "xdg-open android",
+  },
+} as const;
+
+// VSCode settings template
+export const VSCODE_SETTINGS_TEMPLATE = {
+  "dart.flutterSdkPath": ".fvm/flutter_sdk",
+  "editor.formatOnSave": true,
+  "dart.previewFlutterUiGuides": true,
+  "files.exclude": {
+    "**/.git": true,
+    "**/.DS_Store": true,
+    "**/node_modules": true,
+    "**/build": true,
+  },
+} as const;
+
+// Retry configuration
+export const RETRY_CONFIG = {
+  DEFAULT_ATTEMPTS: 3,
+  DEFAULT_DELAY_MS: 10000,
+  IOS_TIMEOUT_MS: 600000,
+} as const;
+
+// Help URLs
+export const HELP_URLS = {
+  FLUTTER_INSTALL: "https://flutter.dev/docs/get-started/install",
+  FVM_INSTALL: "https://fvm.app/docs/getting_started/installation",
+} as const;
+
+// Error messages
+export const ERROR_MESSAGES = {
+  NOT_FLUTTER_PROJECT: "Not a Flutter project: pubspec.yaml not found.",
+  NO_FLUTTER_REFERENCE: "Not a Flutter project: pubspec.yaml does not reference Flutter SDK.",
+  FVM_NOT_FOUND: "FVM Flutter SDK not found at .fvm/flutter_sdk",
+  FLUTTER_NOT_FOUND: "Flutter SDK not found.",
+  IOS_PROJECT_NOT_FOUND: "iOS project directory not found.",
+  ANDROID_PROJECT_NOT_FOUND: "Android project directory not found.",
+  NO_XCODE_PROJECT: "No Xcode project or workspace found in ios/ directory.",
+  NO_BUILD_GRADLE: "No build.gradle found in android/ directory.",
+  MODULE_NAME_EMPTY: "Module name cannot be empty.",
+  MODULE_NAME_INVALID: "Module name must contain only lowercase letters, numbers, and underscores.",
+} as const;
+
+// Info messages
+export const INFO_MESSAGES = {
+  RUN_FROM_PROJECT_ROOT: "Please run this command from the root of a Flutter project.",
+  ADD_IOS_SUPPORT: "Run 'flutter create .' to add iOS support.",
+  ADD_ANDROID_SUPPORT: "Run 'flutter create .' to add Android support.",
+  INSTALL_FVM_OR_DISABLE: "Run 'fvm install' or use --disable-fvm flag.",
+} as const;