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

package/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "electron-cli"
-version = "0.3.0-alpha.1"
+version = "0.3.0-alpha.11"
 edition = "2021"
 description = "Experimental Rust CLI for Electron project diagnostics and workflow automation"
 license = "MIT"
@@ -8,7 +8,17 @@ repository = "https://github.com/Ikana/electron-cli"
 
 [dependencies]
 anyhow = "1.0"
+apple-dmg = "0.5"
 camino = { version = "1.1", features = ["serde1"] }
 clap = { version = "4.6", features = ["derive"] }
+fatfs = "0.3"
+flate2 = { version = "1.1", default-features = false, features = ["rust_backend"] }
+fscommon = "0.1"
+md5 = "0.7"
+plist = "1"
+rpm = { version = "0.24", default-features = false, features = ["payload", "gzip-compression"] }
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
+tar = "0.4"
+ureq = { version = "3.3", features = ["json"] }
+zip = { version = "8.6.0", default-features = false, features = ["deflate-flate2-zlib-rs"] }

package/README.md

@@ -6,7 +6,7 @@ This is an independent learning project. It is not affiliated with Electron, Ele
 
 ## Status
 
-This repository is intentionally small and public-learning friendly. The first useful surface area is inspection and diagnostics, because those commands are valuable for humans and easy for agents to consume safely.
+This repository is intentionally small and public-learning friendly. The first useful surface area is inspection and diagnostics, because those commands are valuable for humans and easy for agents to consume safely. The next surface area is a Rust-owned version of the main Electron Forge flow: initialize, start, package, make, and eventually publish.
 
 Current commands:
 
@@ -14,28 +14,59 @@ Current commands:
 electron-cli inspect
 electron-cli doctor
 electron-cli plan
+electron-cli init my-app
+electron-cli start
+electron-cli package
+electron-cli make
+electron-cli publish
 electron-cli inspect --json
 electron-cli doctor --json
 electron-cli plan --json
+electron-cli init my-app --dry-run --json
+electron-cli start --dry-run --json
+electron-cli package --dry-run --json
+electron-cli make --dry-run --json
+electron-cli publish --dry-run --json
 ```
 
-Planned commands:
+The default `init` template is `minimal`, a built-in starter written by this project. Non-native template names are still passed to `create-electron-app` as an escape hatch while this project grows.
 
-```sh
-electron-cli dev
-electron-cli init
-electron-cli package
-electron-cli make
+The Rust-native flow currently owns:
+
+- `init --template minimal`: writes a local Electron starter without Electron Forge.
+- `start`: launches the installed Electron runtime directly.
+- `package`: copies the installed Electron runtime, app files, installed production dependency closure, app metadata, macOS icon, and extra resources into a local app bundle for the current platform and architecture.
+- `make`: runs `package` and writes a distributable under `out/make/<target>/<platform>/<arch>/`; ZIP works on all platforms, `--target dmg` writes a basic macOS disk image, and `--target deb` / `--target rpm` write Linux packages.
+- `publish`: runs `make` and publishes the distributable to a local directory with a manifest or to GitHub Releases.
+
+The GitHub publisher creates or reuses a release, uploads the selected make artifact, and can replace an existing asset with `--force`. It reads `GITHUB_TOKEN` or `GH_TOKEN` and can infer `OWNER/REPO` from `package.json` `repository`, or you can pass `--github-repo`.
+
+The DMG maker is currently a pure-Rust FAT32 image with the app bundle and an Applications entry. HFS+/APFS layout customization, Windows installers, Windows/Linux icon embedding, signing, and notarization are still TODO.
+
+Package metadata can be configured in `package.json`:
+
+```json
+{
+  "productName": "My App",
+  "electronCli": {
+    "packagerConfig": {
+      "appBundleId": "com.example.my-app",
+      "appCategoryType": "public.app-category.developer-tools",
+      "icon": "assets/icon",
+      "extraResource": "assets/config.json"
+    }
+  }
+}
 ```
 
-The planned workflow commands may start by wrapping Electron Forge or other established tools. Rust-native implementations can replace narrow pieces over time when there is a clear reason.
+The package command also reads JSON-shaped `config.forge.packagerConfig` and `electronPackagerConfig` entries for the same fields. JavaScript Forge config files are not evaluated.
 
 ## Install
 
 During the experimental phase, the npm package downloads a prebuilt binary from GitHub Releases when one is available. If a prebuilt binary is not available for your platform, it falls back to running from Rust source.
 
 ```sh
-npm install -g electron-cli
+npm install -g electron-cli@alpha
 electron-cli doctor
 ```
 
@@ -59,6 +90,16 @@ Or use Cargo directly:
 ```sh
 cargo run -- doctor
 cargo run -- inspect --json
+cargo run -- init my-app
+cargo run -- start --dry-run
+cargo run -- package --dry-run
+cargo run -- make --dry-run
+cargo run -- make --target dmg --dry-run
+cargo run -- make --target deb --dry-run
+cargo run -- make --target rpm --dry-run
+cargo run -- publish --dry-run
+cargo run -- publish --publisher github --dry-run
+cargo run -- publish --publisher github --github-repo OWNER/REPO --github-tag v0.1.0
 ```
 
 ## Design Goals
@@ -66,7 +107,7 @@ cargo run -- inspect --json
 - Learn Rust through a real developer tool.
 - Make Electron project state easy to inspect.
 - Prefer structured output for agentic workflows.
-- Wrap proven ecosystem tools before replacing them.
+- Replace the main Forge-style app flow with narrow Rust-owned pieces.
 - Keep the project clearly independent and experimental.
 
 ## Non-Goals
@@ -77,8 +118,13 @@ cargo run -- inspect --json
 
 ## JSON Output
 
-Both initial commands support `--json` so agents and scripts can consume project state without scraping terminal output.
+The inspection and planning commands support `--json` so agents and scripts can consume project state without scraping terminal output.
 `plan` is designed around that workflow: it recommends stable commands and reports missing project conventions as structured data.
+`init --dry-run --json` shows whether the CLI will write native template files or delegate to `create-electron-app`.
+`start --dry-run --json` shows the Electron executable that will be launched.
+`package --dry-run --json` shows the runtime, app file, metadata, icon, and extra-resource copy plan.
+`make --dry-run --json` shows the package prerequisite and selected maker artifact path.
+`publish --dry-run --json` shows the make prerequisite plus either the local destination/manifest path or the GitHub release/upload plan.
 
 ```sh
 electron-cli plan --json

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-cli",
-  "version": "0.3.0-alpha.1",
+  "version": "0.3.0-alpha.11",
   "description": "Experimental Rust CLI for Electron project diagnostics and workflow automation",
   "license": "MIT",
   "repository": {
@@ -18,6 +18,7 @@
     "bin/electron-cli.js",
     "scripts",
     "src",
+    "templates",
     "tests",
     "Cargo.toml",
     "Cargo.lock",

package/src/cli.rs

@@ -1,6 +1,6 @@
 use std::path::PathBuf;
 
-use clap::{Args, Parser, Subcommand};
+use clap::{Args, Parser, Subcommand, ValueEnum};
 
 #[derive(Debug, Parser)]
 #[command(
@@ -18,10 +18,20 @@ pub struct Cli {
 pub enum Commands {
     /// Check whether the current project looks ready for Electron development.
     Doctor(CommandArgs),
+    /// Bootstrap a new Electron app.
+    Init(InitArgs),
     /// Print a structured snapshot of the current JavaScript/Electron project.
     Inspect(CommandArgs),
+    /// Create distributable artifacts from a packaged Electron app.
+    Make(MakeArgs),
+    /// Create a local Electron application bundle without Electron Forge.
+    Package(PackageArgs),
     /// Recommend next commands and risks from the project snapshot.
     Plan(CommandArgs),
+    /// Publish made artifacts to a distribution target.
+    Publish(PublishArgs),
+    /// Launch the current Electron app without Electron Forge.
+    Start(StartArgs),
 }
 
 #[derive(Debug, Clone, Args)]
@@ -34,3 +44,278 @@ pub struct CommandArgs {
     #[arg(long)]
     pub json: bool,
 }
+
+#[derive(Debug, Clone, Args)]
+pub struct InitArgs {
+    /// Directory to initialize. Defaults to the current directory.
+    #[arg(default_value = ".", value_name = "DIR")]
+    pub dir: PathBuf,
+
+    /// Directory to run the create command from.
+    #[arg(long, default_value = ".", value_name = "PATH")]
+    pub cwd: PathBuf,
+
+    /// Template to use. "minimal" is native; other names are passed to create-electron-app.
+    #[arg(long, short = 't', default_value = "minimal")]
+    pub template: String,
+
+    /// Package manager command strategy to use.
+    #[arg(long, value_enum)]
+    pub package_manager: Option<PackageManager>,
+
+    /// Set a specific Electron version, or use latest/beta/nightly.
+    #[arg(long, value_name = "VERSION")]
+    pub electron_version: Option<String>,
+
+    /// Copy template CI files when the Forge template supports them.
+    #[arg(long)]
+    pub copy_ci_files: bool,
+
+    /// Overwrite an existing target directory.
+    #[arg(long)]
+    pub force: bool,
+
+    /// Skip initializing a git repository in the created project.
+    #[arg(long)]
+    pub skip_git: bool,
+
+    /// Print the command and metadata without creating files.
+    #[arg(long)]
+    pub dry_run: bool,
+
+    /// Emit machine-readable JSON.
+    #[arg(long)]
+    pub json: bool,
+}
+
+#[derive(Debug, Clone, Args)]
+pub struct StartArgs {
+    /// Project directory to launch.
+    #[arg(long, default_value = ".", value_name = "PATH")]
+    pub cwd: PathBuf,
+
+    /// Print the launch command without starting Electron.
+    #[arg(long)]
+    pub dry_run: bool,
+
+    /// Emit machine-readable JSON.
+    #[arg(long)]
+    pub json: bool,
+
+    /// Extra arguments passed to Electron after `--`.
+    #[arg(last = true, value_name = "ELECTRON_ARG")]
+    pub electron_args: Vec<String>,
+}
+
+#[derive(Debug, Clone, Args)]
+pub struct PackageArgs {
+    /// Project directory to package.
+    #[arg(long, default_value = ".", value_name = "PATH")]
+    pub cwd: PathBuf,
+
+    /// Output directory for packaged app bundles.
+    #[arg(long, default_value = "out", value_name = "PATH")]
+    pub out_dir: PathBuf,
+
+    /// Override the packaged application name.
+    #[arg(long)]
+    pub name: Option<String>,
+
+    /// Target platform label. Defaults to the current platform.
+    #[arg(long)]
+    pub platform: Option<String>,
+
+    /// Target architecture label. Defaults to the current architecture.
+    #[arg(long)]
+    pub arch: Option<String>,
+
+    /// Overwrite an existing package output directory.
+    #[arg(long)]
+    pub force: bool,
+
+    /// Print the package plan without creating files.
+    #[arg(long)]
+    pub dry_run: bool,
+
+    /// Emit machine-readable JSON.
+    #[arg(long)]
+    pub json: bool,
+}
+
+#[derive(Debug, Clone, Args)]
+pub struct MakeArgs {
+    /// Project directory to make distributables for.
+    #[arg(long, default_value = ".", value_name = "PATH")]
+    pub cwd: PathBuf,
+
+    /// Output directory used for package and make artifacts.
+    #[arg(long, default_value = "out", value_name = "PATH")]
+    pub out_dir: PathBuf,
+
+    /// Override the application name.
+    #[arg(long)]
+    pub name: Option<String>,
+
+    /// Target platform label. Defaults to the current platform.
+    #[arg(long)]
+    pub platform: Option<String>,
+
+    /// Target architecture label. Defaults to the current architecture.
+    #[arg(long)]
+    pub arch: Option<String>,
+
+    /// Maker target to run.
+    #[arg(long, value_enum, default_value_t = MakeTarget::Zip)]
+    pub target: MakeTarget,
+
+    /// Reuse an existing package output instead of running package first.
+    #[arg(long)]
+    pub skip_package: bool,
+
+    /// Overwrite existing package and make artifacts.
+    #[arg(long)]
+    pub force: bool,
+
+    /// Print the make plan without creating files.
+    #[arg(long)]
+    pub dry_run: bool,
+
+    /// Emit machine-readable JSON.
+    #[arg(long)]
+    pub json: bool,
+}
+
+#[derive(Debug, Clone, Args)]
+pub struct PublishArgs {
+    /// Project directory to publish from.
+    #[arg(long, default_value = ".", value_name = "PATH")]
+    pub cwd: PathBuf,
+
+    /// Output directory used for package, make, and publish artifacts.
+    #[arg(long, default_value = "out", value_name = "PATH")]
+    pub out_dir: PathBuf,
+
+    /// Override the application name.
+    #[arg(long)]
+    pub name: Option<String>,
+
+    /// Target platform label. Defaults to the current platform.
+    #[arg(long)]
+    pub platform: Option<String>,
+
+    /// Target architecture label. Defaults to the current architecture.
+    #[arg(long)]
+    pub arch: Option<String>,
+
+    /// Maker target whose artifact should be published.
+    #[arg(long, value_enum, default_value_t = MakeTarget::Zip)]
+    pub target: MakeTarget,
+
+    /// Publisher target to use.
+    #[arg(long, value_enum, default_value_t = PublishTarget::Local)]
+    pub publisher: PublishTarget,
+
+    /// Destination for local published artifacts.
+    #[arg(long, default_value = "out/publish/local", value_name = "PATH")]
+    pub to: PathBuf,
+
+    /// GitHub repository to publish to, in OWNER/REPO form.
+    #[arg(long, value_name = "OWNER/REPO")]
+    pub github_repo: Option<String>,
+
+    /// GitHub release tag. Defaults to v<package version>, then channel.
+    #[arg(long)]
+    pub github_tag: Option<String>,
+
+    /// GitHub release name. Defaults to the release tag.
+    #[arg(long)]
+    pub github_release_name: Option<String>,
+
+    /// Mark a newly created GitHub release as draft.
+    #[arg(long)]
+    pub github_draft: bool,
+
+    /// Mark a newly created GitHub release as prerelease.
+    #[arg(long)]
+    pub github_prerelease: bool,
+
+    /// GitHub API base URL, useful for GitHub Enterprise.
+    #[arg(long, default_value = "https://api.github.com", value_name = "URL")]
+    pub github_api_url: String,
+
+    /// Release channel label written into the publish manifest.
+    #[arg(long, default_value = "default")]
+    pub channel: String,
+
+    /// Reuse an existing make artifact instead of running package and make first.
+    #[arg(long)]
+    pub skip_make: bool,
+
+    /// Overwrite existing publish artifacts.
+    #[arg(long)]
+    pub force: bool,
+
+    /// Print the publish plan without creating files.
+    #[arg(long)]
+    pub dry_run: bool,
+
+    /// Emit machine-readable JSON.
+    #[arg(long)]
+    pub json: bool,
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
+#[value(rename_all = "lower")]
+pub enum PackageManager {
+    Npm,
+    Pnpm,
+    Yarn,
+    Bun,
+}
+
+impl PackageManager {
+    pub fn as_str(self) -> &'static str {
+        match self {
+            PackageManager::Npm => "npm",
+            PackageManager::Pnpm => "pnpm",
+            PackageManager::Yarn => "yarn",
+            PackageManager::Bun => "bun",
+        }
+    }
+}
+
+#[derive(Debug, Clone, Copy, PartialEq, Eq, ValueEnum)]
+#[value(rename_all = "lower")]
+pub enum MakeTarget {
+    Deb,
+    Dmg,
+    Rpm,
+    Zip,
+}
+
+impl MakeTarget {
+    pub fn as_str(self) -> &'static str {
+        match self {
+            MakeTarget::Deb => "deb",
+            MakeTarget::Dmg => "dmg",
+            MakeTarget::Rpm => "rpm",
+            MakeTarget::Zip => "zip",
+        }
+    }
+}
+
+#[derive(Debug, Clone, Copy, ValueEnum)]
+#[value(rename_all = "lower")]
+pub enum PublishTarget {
+    Github,
+    Local,
+}
+
+impl PublishTarget {
+    pub fn as_str(self) -> &'static str {
+        match self {
+            PublishTarget::Github => "github",
+            PublishTarget::Local => "local",
+        }
+    }
+}