electron-cli 0.3.0-alpha.1 → 0.3.0-alpha.11

package/src/commands/start.rs

@@ -0,0 +1,287 @@
+use std::{
+    path::{Path, PathBuf},
+    process::Command,
+};
+
+use anyhow::{bail, Context, Result};
+use camino::Utf8PathBuf;
+use serde::Serialize;
+
+use crate::{cli::StartArgs, output, project::ProjectSnapshot};
+
+#[derive(Debug, Serialize)]
+struct StartReport {
+    project: ProjectSnapshot,
+    electron_path: Option<Utf8PathBuf>,
+    command: Vec<String>,
+    command_display: String,
+    passthrough_args: Vec<String>,
+    dry_run: bool,
+    status: StartStatus,
+    exit_code: Option<i32>,
+    warnings: Vec<String>,
+}
+
+#[derive(Debug, Serialize)]
+#[serde(rename_all = "kebab-case")]
+enum StartStatus {
+    Planned,
+    Exited,
+}
+
+pub fn run(args: StartArgs) -> Result<()> {
+    let snapshot = crate::project::inspect(&args.cwd)?;
+    let mut report = build_report(snapshot, &args)?;
+
+    if args.dry_run {
+        return print_report(&report, args.json);
+    }
+
+    let exit_code = execute_start(&report)?;
+    report.status = StartStatus::Exited;
+    report.exit_code = exit_code;
+
+    if args.json {
+        output::json(&report)?;
+    }
+
+    if let Some(code) = exit_code {
+        bail!("Electron exited with status code {code}");
+    } else {
+        Ok(())
+    }
+}
+
+fn build_report(snapshot: ProjectSnapshot, args: &StartArgs) -> Result<StartReport> {
+    let root = Path::new(snapshot.root.as_str());
+    let electron_path = find_electron_executable(root);
+    let mut warnings = Vec::new();
+
+    if snapshot.package_json.is_none() {
+        warnings.push("No package.json found.".to_string());
+    }
+
+    if snapshot.electron_dependency.is_none() {
+        warnings.push("No electron dependency is declared in package.json.".to_string());
+    }
+
+    if electron_path.is_none() {
+        warnings.push(
+            "Electron executable was not found under node_modules/electron/dist.".to_string(),
+        );
+    }
+
+    let mut command = Vec::new();
+    if let Some(path) = &electron_path {
+        command.push(path_arg(path));
+        command.push(snapshot.root.to_string());
+        command.extend(args.electron_args.clone());
+    }
+
+    let command_display = if command.is_empty() {
+        "electron executable not found".to_string()
+    } else {
+        display_command(&command)
+    };
+
+    Ok(StartReport {
+        project: snapshot,
+        electron_path: electron_path.map(utf8_path).transpose()?,
+        command,
+        command_display,
+        passthrough_args: args.electron_args.clone(),
+        dry_run: args.dry_run,
+        status: StartStatus::Planned,
+        exit_code: None,
+        warnings,
+    })
+}
+
+fn execute_start(report: &StartReport) -> Result<Option<i32>> {
+    if report.project.package_json.is_none() {
+        bail!("No package.json found. Run electron-cli start inside an Electron project.");
+    }
+
+    if report.project.electron_dependency.is_none() {
+        bail!("No electron dependency found. Install Electron before starting the app.");
+    }
+
+    let (program, args) = report
+        .command
+        .split_first()
+        .context("Electron executable was not found. Run your package manager install first.")?;
+
+    let status = Command::new(program)
+        .args(args)
+        .current_dir(report.project.root.as_str())
+        .status()
+        .with_context(|| format!("Could not execute {}", report.command_display))?;
+
+    if status.success() {
+        Ok(None)
+    } else {
+        Ok(status.code())
+    }
+}
+
+fn print_report(report: &StartReport, json: bool) -> Result<()> {
+    if json {
+        return output::json(report);
+    }
+
+    println!("electron-cli start");
+    println!();
+    println!("Project");
+    println!("  root: {}", report.project.root);
+    match report.project.package_label() {
+        Some(label) => println!("  package: {label}"),
+        None => println!("  package: not found"),
+    }
+
+    println!();
+    println!("Command");
+    println!("  {}", report.command_display);
+
+    if !report.warnings.is_empty() {
+        println!();
+        println!("Warnings");
+        for warning in &report.warnings {
+            println!("  {warning}");
+        }
+    }
+
+    Ok(())
+}
+
+fn find_electron_executable(root: &Path) -> Option<PathBuf> {
+    let dist = root.join("node_modules/electron/dist");
+    let candidates = electron_executable_candidates(&dist);
+
+    candidates.into_iter().find(|path| path.exists())
+}
+
+fn electron_executable_candidates(dist: &Path) -> Vec<PathBuf> {
+    if cfg!(target_os = "macos") {
+        vec![
+            dist.join("Electron.app/Contents/MacOS/Electron"),
+            dist.join("electron"),
+        ]
+    } else if cfg!(target_os = "windows") {
+        vec![dist.join("electron.exe")]
+    } else {
+        vec![dist.join("electron")]
+    }
+}
+
+fn display_command(command: &[String]) -> String {
+    command
+        .iter()
+        .map(|arg| shell_quote(arg))
+        .collect::<Vec<_>>()
+        .join(" ")
+}
+
+fn shell_quote(value: &str) -> String {
+    if value
+        .chars()
+        .all(|char| char.is_ascii_alphanumeric() || matches!(char, '.' | '/' | '-' | '_' | '@'))
+    {
+        value.to_string()
+    } else {
+        format!("'{}'", value.replace('\'', "'\\''"))
+    }
+}
+
+fn path_arg(path: &Path) -> String {
+    path.to_string_lossy().to_string()
+}
+
+fn utf8_path(path: PathBuf) -> Result<Utf8PathBuf> {
+    Utf8PathBuf::from_path_buf(path).map_err(|path| {
+        anyhow::anyhow!(
+            "Path contains invalid UTF-8 and cannot be represented in JSON: {}",
+            path.display()
+        )
+    })
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use std::fs;
+
+    #[test]
+    fn plans_start_command_when_electron_dist_exists() {
+        let root = unique_temp_dir();
+        write_package_json(&root);
+        write_fake_electron(&root);
+
+        let args = StartArgs {
+            cwd: root.clone(),
+            dry_run: true,
+            json: true,
+            electron_args: vec!["--trace-warnings".to_string()],
+        };
+        let snapshot = crate::project::inspect(&root).expect("project should inspect");
+        let report = build_report(snapshot, &args).expect("report should build");
+
+        assert!(report.electron_path.is_some());
+        assert!(report.command_display.contains("--trace-warnings"));
+        assert!(report.warnings.is_empty());
+
+        let _ = fs::remove_dir_all(root);
+    }
+
+    #[test]
+    fn reports_missing_electron_dist_as_warning() {
+        let root = unique_temp_dir();
+        write_package_json(&root);
+
+        let args = StartArgs {
+            cwd: root.clone(),
+            dry_run: true,
+            json: true,
+            electron_args: Vec::new(),
+        };
+        let snapshot = crate::project::inspect(&root).expect("project should inspect");
+        let report = build_report(snapshot, &args).expect("report should build");
+
+        assert!(report.electron_path.is_none());
+        assert!(report.warnings.contains(
+            &"Electron executable was not found under node_modules/electron/dist.".to_string()
+        ));
+
+        let _ = fs::remove_dir_all(root);
+    }
+
+    fn write_package_json(root: &Path) {
+        fs::write(
+            root.join("package.json"),
+            r#"{"name":"starter","version":"0.1.0","main":"src/main.js","devDependencies":{"electron":"30.0.0"}}"#,
+        )
+        .expect("package.json should be written");
+    }
+
+    fn write_fake_electron(root: &Path) {
+        let path = electron_executable_candidates(&root.join("node_modules/electron/dist"))
+            .into_iter()
+            .next()
+            .expect("candidate should exist");
+        fs::create_dir_all(path.parent().expect("candidate should have parent"))
+            .expect("electron parent should be created");
+        fs::write(path, "").expect("electron executable should be written");
+    }
+
+    fn unique_temp_dir() -> PathBuf {
+        let nanos = std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .expect("clock should be after epoch")
+            .as_nanos();
+        let path = std::env::temp_dir().join(format!(
+            "electron-cli-start-test-{}-{nanos}",
+            std::process::id()
+        ));
+        fs::create_dir_all(&path).expect("temp dir should be created");
+        path
+    }
+}

package/src/main.rs

@@ -19,7 +19,12 @@ fn run() -> Result<()> {
 
     match cli.command {
         Commands::Doctor(args) => commands::doctor::run(args),
+        Commands::Init(args) => commands::init::run(args),
         Commands::Inspect(args) => commands::inspect::run(args),
+        Commands::Make(args) => commands::make::run(args),
+        Commands::Package(args) => commands::package::run(args),
         Commands::Plan(args) => commands::plan::run(args),
+        Commands::Publish(args) => commands::publish::run(args),
+        Commands::Start(args) => commands::start::run(args),
     }
 }

package/src/project.rs

@@ -15,6 +15,8 @@ pub struct ProjectSnapshot {
     pub package_json: Option<Utf8PathBuf>,
     pub name: Option<String>,
     pub version: Option<String>,
+    pub repository: Option<String>,
+    pub license: Option<String>,
     pub main: Option<String>,
     pub package_manager: Option<String>,
     pub scripts: BTreeMap<String, String>,
@@ -128,6 +130,12 @@ pub fn inspect(cwd: &Path) -> Result<ProjectSnapshot> {
             .and_then(|package| package.get("version"))
             .and_then(Value::as_str)
             .map(ToOwned::to_owned),
+        repository: package_json.as_ref().and_then(repository_value),
+        license: package_json
+            .as_ref()
+            .and_then(|package| package.get("license"))
+            .and_then(Value::as_str)
+            .map(ToOwned::to_owned),
         main: package_json
             .as_ref()
             .and_then(|package| package.get("main"))
@@ -145,6 +153,17 @@ pub fn inspect(cwd: &Path) -> Result<ProjectSnapshot> {
     })
 }
 
+fn repository_value(package: &Value) -> Option<String> {
+    match package.get("repository") {
+        Some(Value::String(repository)) => Some(repository.clone()),
+        Some(Value::Object(repository)) => repository
+            .get("url")
+            .and_then(Value::as_str)
+            .map(ToOwned::to_owned),
+        _ => None,
+    }
+}
+
 fn string_map(value: Option<&Value>) -> BTreeMap<String, String> {
     value
         .and_then(Value::as_object)
@@ -261,6 +280,25 @@ mod tests {
         assert!(!map.contains_key("bad"));
     }
 
+    #[test]
+    fn inspects_repository_url() {
+        let root = unique_temp_dir("repository");
+        fs::write(
+            root.join("package.json"),
+            r#"{"name":"repo-app","repository":{"type":"git","url":"git+https://github.com/Ikana/electron-cli.git"}}"#,
+        )
+        .expect("package.json should be written");
+
+        let snapshot = inspect(&root).expect("project should inspect");
+
+        assert_eq!(
+            snapshot.repository.as_deref(),
+            Some("git+https://github.com/Ikana/electron-cli.git")
+        );
+
+        let _ = fs::remove_dir_all(root);
+    }
+
     #[test]
     fn builds_electron_signals() {
         let mut scripts = BTreeMap::new();
@@ -317,4 +355,17 @@ mod tests {
             .signals
             .contains(&"electron command found in package scripts".to_string()));
     }
+
+    fn unique_temp_dir(label: &str) -> PathBuf {
+        let nanos = std::time::SystemTime::now()
+            .duration_since(std::time::UNIX_EPOCH)
+            .expect("clock should be after epoch")
+            .as_nanos();
+        let path = std::env::temp_dir().join(format!(
+            "electron-cli-project-{label}-{}-{nanos}",
+            std::process::id()
+        ));
+        fs::create_dir_all(&path).expect("temp dir should be created");
+        path
+    }
 }

package/templates/minimal/gitignore

@@ -0,0 +1,5 @@
+node_modules
+out
+dist
+.DS_Store
+*.log

package/templates/minimal/src/index.html

@@ -0,0 +1,82 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>electron-cli</title>
+    <style>
+      :root {
+        color-scheme: light dark;
+        font-family:
+          Inter, ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont,
+          "Segoe UI", sans-serif;
+        background: #f5f5f2;
+        color: #1d2328;
+      }
+
+      body {
+        margin: 0;
+        min-height: 100vh;
+        display: grid;
+        place-items: center;
+      }
+
+      main {
+        width: min(720px, calc(100vw - 48px));
+      }
+
+      h1 {
+        margin: 0 0 12px;
+        font-size: 5rem;
+        line-height: 0.92;
+        letter-spacing: 0;
+      }
+
+      p {
+        max-width: 48rem;
+        margin: 0 0 24px;
+        font-size: 1.05rem;
+        line-height: 1.6;
+      }
+
+      dl {
+        display: grid;
+        grid-template-columns: max-content 1fr;
+        gap: 8px 16px;
+        margin: 0;
+        padding-top: 20px;
+        border-top: 1px solid color-mix(in srgb, currentColor 24%, transparent);
+      }
+
+      dt {
+        font-weight: 700;
+      }
+
+      dd {
+        margin: 0;
+      }
+
+      @media (max-width: 640px) {
+        h1 {
+          font-size: 3rem;
+        }
+      }
+    </style>
+  </head>
+  <body>
+    <main>
+      <h1>electron-cli</h1>
+      <p>
+        This app was generated by the experimental Rust-native electron-cli
+        template.
+      </p>
+      <dl>
+        <dt>Runtime</dt>
+        <dd id="runtime">Loading...</dd>
+        <dt>Platform</dt>
+        <dd id="platform">Loading...</dd>
+      </dl>
+    </main>
+    <script src="./renderer.js"></script>
+  </body>
+</html>

package/templates/minimal/src/main.js

@@ -0,0 +1,33 @@
+const { app, BrowserWindow } = require("electron");
+const path = require("node:path");
+
+function createWindow() {
+  const window = new BrowserWindow({
+    width: 960,
+    height: 640,
+    minWidth: 640,
+    minHeight: 420,
+    title: "electron-cli",
+    webPreferences: {
+      preload: path.join(__dirname, "preload.js"),
+    },
+  });
+
+  window.loadFile(path.join(__dirname, "index.html"));
+}
+
+app.whenReady().then(() => {
+  createWindow();
+
+  app.on("activate", () => {
+    if (BrowserWindow.getAllWindows().length === 0) {
+      createWindow();
+    }
+  });
+});
+
+app.on("window-all-closed", () => {
+  if (process.platform !== "darwin") {
+    app.quit();
+  }
+});

package/templates/minimal/src/preload.js

@@ -0,0 +1,6 @@
+const { contextBridge } = require("electron");
+
+contextBridge.exposeInMainWorld("electronCli", {
+  platform: process.platform,
+  versions: process.versions,
+});

package/templates/minimal/src/renderer.js

@@ -0,0 +1,5 @@
+const runtime = document.querySelector("#runtime");
+const platform = document.querySelector("#platform");
+
+runtime.textContent = `Electron ${window.electronCli.versions.electron}`;
+platform.textContent = window.electronCli.platform;