optikit 1.2.0 → 1.2.1

package/CHANGELOG.md

@@ -10,6 +10,22 @@ We follow Semantic Versioning (SemVer) to indicate the nature of changes:
 
 Each section lists the changes in chronological order, with the most recent release at the top. We also include links to relevant discussions or issues when appropriate.
 
+## [1.2.1]
+
+### Added
+
+- **Open Build Output Commands:** New commands to quickly access build artifacts:
+  - `open-ipa` - Opens the IPA build output directory (`build/ios/ipa/`)
+  - `open-apk` - Opens the APK build output directory (`build/app/outputs/flutter-apk/`)
+  - `open-bundle` - Opens the Android Bundle output directory (`build/app/outputs/bundle/release/`)
+- **Cross-Platform Support:** All open commands work seamlessly on macOS (Finder), Windows (Explorer), and Linux (default file manager)
+- **Smart Validation:** Commands check if build output exists before attempting to open, with helpful error messages
+
+### Improved
+
+- **Documentation:** Updated USAGE.md with comprehensive open build output commands section
+- **User Experience:** No need for shell aliases to access build outputs - built directly into the CLI
+
 ## [1.2.0]
 
 ### Added

package/USAGE.md

@@ -330,6 +330,45 @@ optikit open-ios
 
 ---
 
+### Open Build Output Directories
+
+Quickly access your build artifacts in Finder (macOS), File Explorer (Windows), or your default file manager (Linux).
+
+**Open IPA build output:**
+
+```bash
+optikit open-ipa
+```
+
+Opens: `build/ios/ipa/`
+
+**Open APK build output:**
+
+```bash
+optikit open-apk
+```
+
+Opens: `build/app/outputs/flutter-apk/`
+
+**Open Android Bundle build output:**
+
+```bash
+optikit open-bundle
+```
+
+Opens: `build/app/outputs/bundle/release/`
+
+**What it does:**
+
+- Validates that you're in a Flutter project
+- Checks if the build output directory exists
+- Opens the directory in your system's default file manager
+- Works cross-platform (macOS, Windows, Linux)
+
+**Note:** You must build the respective artifact first before opening its output directory.
+
+---
+
 ### VS Code Setup Command
 
 Automatically create a `.vscode` folder with a `settings.json` file preconfigured for Flutter projects using FVM. This command streamlines your project setup by setting the Flutter SDK path to `.fvm/flutter_sdk`.

package/dist/cli.js

@@ -9,7 +9,7 @@ import { cleanIosProject } from "./commands/clean/ios.js";
 import { updateFlutterVersion } from "./commands/version/update.js";
 import { buildFlutterApk, buildFlutterBundle, buildFlutterIos, buildFlutterIpa, } from "./commands/build/releases.js";
 import { boxenOptions } from "./styles.js";
-import { openIos, openAndroid } from "./commands/project/open.js";
+import { openIos, openAndroid, openIpaOutput, openBundleOutput, openApkOutput } from "./commands/project/open.js";
 import { createRequire } from "module";
 import { createVscodeSettings } from "./commands/project/setup.js";
 import { initializeProject } from "./commands/config/init.js";
@@ -129,7 +129,17 @@ const options = yargs(hideBin(process.argv))
 })
     .command("open-android", "Open the Android project in Android Studio", {}, async () => {
     await openAndroid();
-}).command("setup-vscode", "Create a .vscode folder with recommended Flutter settings", () => { }, async () => {
+})
+    .command("open-ipa", "Open the IPA build output directory", {}, async () => {
+    await openIpaOutput();
+})
+    .command("open-apk", "Open the APK build output directory", {}, async () => {
+    await openApkOutput();
+})
+    .command("open-bundle", "Open the Android Bundle build output directory", {}, async () => {
+    await openBundleOutput();
+})
+    .command("setup-vscode", "Create a .vscode folder with recommended Flutter settings", () => { }, async () => {
     await createVscodeSettings();
 })
     .command("init", "Initialize OptiKit configuration in the current project", () => { }, async () => {

package/dist/commands/project/open.js

@@ -2,7 +2,9 @@ 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";
-export { openIos, openAndroid };
+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
@@ -61,3 +63,101 @@ async function openAndroid() {
         process.exit(1);
     }
 }
+/**
+ * Opens the IPA build output directory in Finder (macOS) or File Explorer (Windows/Linux)
+ */
+async function openIpaOutput() {
+    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() {
+    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() {
+    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() {
+    const osPlatform = platform();
+    switch (osPlatform) {
+        case "darwin": // macOS
+            return "open";
+        case "win32": // Windows
+            return "start";
+        default: // Linux and others
+            return "xdg-open";
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "optikit",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "OptiKit CLI",
   "main": "src/cli.ts",
   "type": "module",

package/src/cli.ts

@@ -15,7 +15,7 @@ import {
   buildFlutterIpa,
 } from "./commands/build/releases.js";
 import { boxenOptions } from "./styles.js";
-import { openIos, openAndroid } from "./commands/project/open.js";
+import { openIos, openAndroid, openIpaOutput, openBundleOutput, openApkOutput } from "./commands/project/open.js";
 import { createRequire } from "module";
 import { createVscodeSettings } from "./commands/project/setup.js";
 import { initializeProject } from "./commands/config/init.js";
@@ -192,7 +192,32 @@ const options = yargs(hideBin(process.argv))
     async () => {
       await openAndroid();
     }
-  ).command(
+  )
+  .command(
+    "open-ipa",
+    "Open the IPA build output directory",
+    {},
+    async () => {
+      await openIpaOutput();
+    }
+  )
+  .command(
+    "open-apk",
+    "Open the APK build output directory",
+    {},
+    async () => {
+      await openApkOutput();
+    }
+  )
+  .command(
+    "open-bundle",
+    "Open the Android Bundle build output directory",
+    {},
+    async () => {
+      await openBundleOutput();
+    }
+  )
+  .command(
     "setup-vscode",
     "Create a .vscode folder with recommended Flutter settings",
     () => {},

package/src/commands/project/open.ts

@@ -2,8 +2,10 @@ 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 };
+export { openIos, openAndroid, openIpaOutput, openBundleOutput, openApkOutput };
 
 async function openIos() {
   LoggerHelpers.info("Opening the iOS project in Xcode...");
@@ -70,3 +72,122 @@ async function openAndroid() {
       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";
+  }
+}