Add Flatpak build system and support

.gitignore

@@ -25,3 +25,5 @@ DerivedData/
 .blob_store
 .vscode
 .wrangler
+.flatpak-builder
+flatpak-cargo-sources.json

crates/cli/Cargo.toml

@@ -16,6 +16,9 @@ doctest = false
 name = "cli"
 path = "src/main.rs"
 
+[features]
+flatpak = []
+
 [dependencies]
 anyhow.workspace = true
 clap.workspace = true

crates/cli/src/main.rs

@@ -43,6 +43,7 @@ struct Args {
     /// Run zed in the foreground (useful for debugging)
     #[arg(long)]
     foreground: bool,
+    #[cfg(not(feature = "flatpak"))]
     /// Custom path to Zed.app or the zed binary
     #[arg(long)]
     zed: Option<PathBuf>,
@@ -72,7 +73,12 @@ fn main() -> Result<()> {
     }
     let args = Args::parse();
 
-    let app = Detect::detect(args.zed.as_deref()).context("Bundle detection")?;
+    #[cfg(feature = "flatpak")]
+    let binary_path = Some("/app/bin/zed-app");
+    #[cfg(not(feature = "flatpak"))]
+    let binary_path = args.zed;
+
+    let app = Detect::detect(binary_path).context("Bundle detection")?;
 
     if args.version {
         println!("{}", app.zed_version_string());
@@ -174,9 +180,9 @@ mod linux {
     struct App(PathBuf);
 
     impl Detect {
-        pub fn detect(path: Option<&Path>) -> anyhow::Result<impl InstalledApp> {
+        pub fn detect<P: AsRef<Path>>(path: Option<P>) -> anyhow::Result<impl InstalledApp> {
             let path = if let Some(path) = path {
-                path.to_path_buf().canonicalize()
+                path.as_ref().to_path_buf().canonicalize()
             } else {
                 let cli = env::current_exe()?;
                 let dir = cli
@@ -226,15 +232,29 @@ mod linux {
         }
 
         fn run_foreground(&self, ipc_url: String) -> io::Result<ExitStatus> {
-            std::process::Command::new(self.0.clone())
-                .arg(ipc_url)
-                .status()
+            #[cfg(not(feature = "flatpak"))]
+            let program = self.0.clone();
+            #[cfg(feature = "flatpak")]
+            let program = "/usr/bin/flatpak-spawn";
+
+            let args = vec![OsString::from(ipc_url)];
+            #[cfg(feature = "flatpak")]
+            let args = flatpak_spawn_args(args);
+
+            std::process::Command::new(program).args(args).status()
         }
     }
 
     impl App {
         fn boot_background(&self, ipc_url: String) -> anyhow::Result<()> {
-            let path = &self.0;
+            #[cfg(not(feature = "flatpak"))]
+            let program = self.0.clone();
+            #[cfg(feature = "flatpak")]
+            let program = "/usr/bin/flatpak-spawn";
+
+            let args = vec![OsString::from(&program), OsString::from(ipc_url)];
+            #[cfg(feature = "flatpak")]
+            let args = flatpak_spawn_args(args);
 
             match fork::fork() {
                 Ok(Fork::Parent(_)) => Ok(()),
@@ -249,10 +269,9 @@ mod linux {
                             eprintln!("failed to close_fd: {}", std::io::Error::last_os_error());
                         }
                     }
-                    let error =
-                        exec::execvp(path.clone(), &[path.as_os_str(), &OsString::from(ipc_url)]);
+                    let error = exec::execvp(&program, args);
                     // if exec succeeded, we never get here.
-                    eprintln!("failed to exec {:?}: {}", path, error);
+                    eprintln!("failed to exec {:?}: {}", program, error);
                     process::exit(1)
                 }
                 Err(_) => Err(anyhow!(io::Error::last_os_error())),
@@ -273,6 +292,26 @@ mod linux {
             sock.connect_addr(&sock_addr)
         }
     }
+
+    #[cfg(feature = "flatpak")]
+    fn flatpak_spawn_args(mut args: Vec<OsString>) -> Vec<OsString> {
+        // When running flatpak-spawn with --host, we no longer have access to /app/bin, so we need to find the location on the host system
+        let install_dir = std::process::Command::new("/usr/bin/flatpak-spawn")
+            .arg("--host")
+            .arg("flatpak")
+            .arg("info")
+            .arg("--show-location")
+            .arg(env::var("FLATPAK_ID").unwrap())
+            .output()
+            .unwrap();
+        let install_dir = PathBuf::from(String::from_utf8(install_dir.stdout).unwrap().trim());
+        let app_cmd = install_dir.join("files").join("bin").join("zed-app");
+
+        let mut out_args = vec!["--host".into()];
+        out_args.push(app_cmd.into());
+        out_args.append(&mut args);
+        out_args
+    }
 }
 
 // todo("windows")
@@ -297,7 +336,7 @@ mod windows {
     }
 
     impl Detect {
-        pub fn detect(_path: Option<&Path>) -> anyhow::Result<impl InstalledApp> {
+        pub fn detect<P: AsRef<Path>>(_path: Option<P>) -> anyhow::Result<impl InstalledApp> {
             Ok(App)
         }
     }
@@ -354,11 +393,14 @@ mod mac_os {
     }
 
     impl Detect {
-        pub fn detect(path: Option<&Path>) -> anyhow::Result<impl InstalledApp> {
+        pub fn detect<P: AsRef<Path>>(path: Option<P>) -> anyhow::Result<impl InstalledApp> {
             let bundle_path = if let Some(bundle_path) = path {
-                bundle_path
-                    .canonicalize()
-                    .with_context(|| format!("Args bundle path {bundle_path:?} canonicalization"))?
+                bundle_path.as_ref().canonicalize().with_context(|| {
+                    format!(
+                        "Args bundle path {:?} canonicalization",
+                        bundle_path.as_ref()
+                    )
+                })?
             } else {
                 locate_bundle().context("bundle autodiscovery")?
             };

crates/zed/resources/flatpak/dev.zed.Zed.metainfo.xml

@@ -0,0 +1,82 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="desktop-application">
+    <id>dev.zed.Zed</id>
+    <metadata_license>MIT</metadata_license>
+    <project_license>AGPL-3.0-or-later and Apache-2.0 and GPL-3.0-or-later</project_license>
+
+    <name>Zed</name>
+    <summary>High-performance, multiplayer code editor</summary>
+    <developer id="dev.zed">
+        <name translate="no">Zed Industries, Inc.</name>
+    </developer>
+    <description>
+        <p>
+            Productive coding starts with a tool that stays out of your way. Zed blends the power of an IDE with the speed of a lightweight editor for productivity you can feel under your fingertips.
+        </p>
+        <p>Features:</p>
+        <p>
+            Performance: Efficiently uses every CPU core and your GPU for instant startup, quick file loading, and responsive keystrokes.
+        </p>
+        <p>
+            Language-aware: Maintains a syntax tree for precise highlighting, and auto-indent, with LSP support for autocompletion and refactoring.
+        </p>
+        <p>
+            Collaboration: Real-time editing and navigation for multiple developers in a shared workspace.
+        </p>
+        <p>
+            AI Integration: Integrates GitHub Copilot and GPT-4 for natural language code generation.
+        </p>
+    </description>
+
+    <launchable type="desktop-id">dev.zed.Zed.desktop</launchable>
+
+    <branding>
+        <color type="primary" scheme_preference="light">#99c1f1</color>
+        <color type="primary" scheme_preference="dark">#3180df</color>
+    </branding>
+
+    <content_rating type="oars-1.1">
+        <content_attribute id="social-chat">intense</content_attribute>
+        <content_attribute id="social-audio">intense</content_attribute>
+    </content_rating>
+
+    <url type="homepage">https://zed.dev</url>
+    <url type="bugtracker">https://github.com/zed-industries/zed/issues</url>
+    <url type="faq">https://zed.dev/faq</url>
+    <url type="help">https://zed.dev/docs/getting-started</url>
+    <url type="contact">https://zed.dev/docs/feedback-and-support</url>
+    <url type="vcs-browser">https://github.com/zed-industries/zed</url>
+    <url type="contribute">https://github.com/zed-industries/zed/blob/main/CONTRIBUTING.md</url>
+
+    <supports>
+        <internet>offline-only</internet>
+    </supports>
+    <recommends>
+        <control>pointing</control>
+        <control>keyboard</control>
+        <display_length compare="ge">768</display_length>
+    </recommends>
+
+    <screenshots>
+        <screenshot type="default">
+            <caption>Zed with a large project open, showing language server and gitblame support</caption>
+            <image type="source" width="1122" height="859" xml:lang="en">https://raw.githubusercontent.com/someone13574/zed/flatpak/crates/zed/resources/flatpak/screenshots/screenshot-0.png</image>
+        </screenshot>
+        <screenshot>
+            <caption>Zed with a file open and a channel message thread in the right sidebar</caption>
+            <image type="source" width="1122" height="859" xml:lang="en">https://raw.githubusercontent.com/someone13574/zed/flatpak/crates/zed/resources/flatpak/screenshots/screenshot-1.png</image>
+        </screenshot>
+        <screenshot>
+            <caption>Example of a channel's shared document</caption>
+            <image type="source" width="1122" height="859" xml:lang="en">https://raw.githubusercontent.com/someone13574/zed/flatpak/crates/zed/resources/flatpak/screenshots/screenshot-2.png</image>
+        </screenshot>
+        <screenshot>
+            <caption>Zed's extension list</caption>
+            <image type="source" width="1122" height="859" xml:lang="en">https://raw.githubusercontent.com/someone13574/zed/flatpak/crates/zed/resources/flatpak/screenshots/screenshot-3.png</image>
+        </screenshot>
+        <screenshot>
+            <caption>Theme switcher UI and example theme</caption>
+            <image type="source" width="1122" height="859" xml:lang="en">https://raw.githubusercontent.com/someone13574/zed/flatpak/crates/zed/resources/flatpak/screenshots/screenshot-4.png</image>
+        </screenshot>
+    </screenshots>
+</component>

dev.zed.Zed.json

@@ -0,0 +1,64 @@
+{
+    "id": "dev.zed.Zed",
+    "runtime": "org.freedesktop.Platform",
+    "runtime-version": "23.08",
+    "sdk": "org.freedesktop.Sdk",
+    "sdk-extensions": [
+        "org.freedesktop.Sdk.Extension.rust-stable"
+    ],
+    "command": "zed",
+    "finish-args": [
+        "--socket=session-bus"
+    ],
+    "build-options": {
+        "append-path": "/usr/lib/sdk/rust-stable/bin"
+    },
+    "modules": [
+        {
+            "name": "zed-app",
+            "buildsystem": "simple",
+            "build-options": {
+                "env": {
+                    "CARGO_HOME": "/run/build/zed-app/cargo"
+                }
+            },
+            "build-commands": [
+                "cargo --offline fetch --manifest-path Cargo.toml",
+                "cargo --offline build --release",
+                "install -Dm755 ./target/release/Zed /app/bin/zed-app"
+            ],
+            "sources": [
+                {
+                    "type": "dir",
+                    "path": "."
+                },
+                "flatpak-cargo-sources.json"
+            ]
+        },
+        {
+            "name": "zed",
+            "buildsystem": "simple",
+            "build-options": {
+                "env": {
+                    "CARGO_HOME": "/run/build/zed/cargo"
+                }
+            },
+            "build-commands": [
+                "cargo --offline fetch --manifest-path Cargo.toml",
+                "cargo --offline build --release --package cli --features flatpak",
+                "install -Dm755 ./target/release/cli /app/bin/zed",
+                "install -Dm644 crates/zed/resources/zed.desktop /app/share/applications/${FLATPAK_ID}.desktop",
+                "install -Dm644 crates/zed/resources/flatpak/${FLATPAK_ID}.metainfo.xml -t /app/share/metainfo",
+                "install -Dm644 crates/zed/resources/app-icon.png /app/share/icons/hicolor/512x512/apps/${FLATPAK_ID}.png",
+                "sed -i 's|Icon=zed|Icon=dev.zed.Zed|g' /app/share/applications/${FLATPAK_ID}.desktop"
+            ],
+            "sources": [
+                {
+                    "type": "dir",
+                    "path": "."
+                },
+                "flatpak-cargo-sources.json"
+            ]
+        }
+    ]
+}

docs/src/development/linux.md

@@ -70,6 +70,16 @@ cargo test --workspace
 
 Zed has basic support for both modes. The mode is selected at runtime. If you're on wayland and want to run in X11 mode, you can set `WAYLAND_DISPLAY='' cargo run` to do so.
 
+## Flatpak
+
+To build & install the flatpak package locally follow the steps below:
+
+1. Install flatpak for your distribution as outlined [here](https://flathub.org/setup).
+2. Run the `script/flatpak` script to install the Freedesktop Platform and SDK.
+3. Generate the sources file by running `python script/flatpak-cargo-generator.py` *from the project root directory*. This will need to be re-run if any cargo dependencies are changed (you will know to re-run when the build starts failing).
+4. Now you are ready to build & install the flatpak. Run `flatpak-builder --user --install --force-clean build dev.zed.Zed.json` from the root directory.
+5. To start the application, run `flatpak run dev.zed.Zed` or locate the program in your menu.
+
 ## Troubleshooting
 
 ### Can't compile zed

script/flatpak

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+flatpak remote-add --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
+
+arch=$(arch)
+fd_version=23.08
+flatpak install -y org.freedesktop.Platform/${arch}/${fd_version}
+flatpak install -y org.freedesktop.Sdk/${arch}/${fd_version}
+flatpak install -y org.freedesktop.Sdk.Extension.rust-stable/${arch}/${fd_version}