Greet users who run typst for the first time (#5210)

Author: laurmaedje

Cargo.lock

@@ -38,13 +38,14 @@ bytemuck = "1"
 chinese-number = { version = "0.7.2", default-features = false, features = ["number-to-chinese"] }
 chrono = { version = "0.4.24", default-features = false, features = ["clock", "std"] }
 ciborium = "0.2.1"
-clap = { version = "4.4", features = ["derive", "env"] }
+clap = { version = "4.4", features = ["derive", "env", "wrap_help"] }
 clap_complete = "4.2.1"
 clap_mangen = "0.2.10"
-ctrlc = "3.4.1"
 codespan-reporting = "0.11"
+color-print = "0.3.6"
 comemo = "0.4"
 csv = "1"
+ctrlc = "3.4.1"
 dirs = "5"
 ecow = { version = "0.2", features = ["serde"] }
 env_proxy = "0.4"
@@ -84,8 +85,8 @@ png = "0.17"
 portable-atomic = "1.6"
 proc-macro2 = "1"
 pulldown-cmark = "0.9"
-quote = "1"
 qcms = "0.3.0"
+quote = "1"
 rayon = "1.7.0"
 regex = "1"
 resvg = { version = "0.43", default-features = false, features = ["raster-images"] }

Cargo.toml

@@ -28,6 +28,7 @@ typst-svg = { workspace = true }
 typst-timing = { workspace = true }
 chrono = { workspace = true }
 clap = { workspace = true }
+color-print = { workspace = true }
 codespan-reporting = { workspace = true }
 comemo = { workspace = true }
 dirs = { workspace = true }
@@ -59,6 +60,7 @@ chrono = { workspace = true }
 clap = { workspace = true, features = ["string"] }
 clap_complete = { workspace = true }
 clap_mangen = { workspace = true }
+color-print = { workspace = true }
 semver = { workspace = true }
 
 [features]

crates/typst-cli/Cargo.toml

@@ -13,9 +13,36 @@ use semver::Version;
 /// in environment variables.
 const ENV_PATH_SEP: char = if cfg!(windows) { ';' } else { ':' };
 
-/// The Typst compiler.
+/// The overall structure of the help.
+#[rustfmt::skip]
+const HELP_TEMPLATE: &str = "\
+Typst {version}
+
+{usage-heading} {usage}
+
+{all-args}{after-help}\
+";
+
+/// Adds a list of useful links after the normal help.
+#[rustfmt::skip]
+const AFTER_HELP: &str = color_print::cstr!("\
+<s><u>Resources:</></>
+  <s>Tutorial:</>                 https://typst.app/docs/tutorial/
+  <s>Reference documentation:</>  https://typst.app/docs/reference/
+  <s>Templates & Packages:</>     https://typst.app/universe/
+  <s>Forum for questions:</>      https://forum.typst.app/
+");
+
+/// The Typst compiler
 #[derive(Debug, Clone, Parser)]
-#[clap(name = "typst", version = crate::typst_version(), author)]
+#[clap(
+    name = "typst",
+    version = crate::typst_version(),
+    author,
+    help_template = HELP_TEMPLATE,
+    after_help = AFTER_HELP,
+    max_term_width = 80,
+)]
 pub struct CliArguments {
     /// The command to run
     #[command(subcommand)]

crates/typst-cli/src/args.rs

@@ -0,0 +1,66 @@
+use std::io::{self, Read};
+
+/// This is shown to users who just type `typst` the first time.
+#[rustfmt::skip]
+const GREETING: &str = color_print::cstr!("\
+<s>Welcome to Typst, we are glad to have you here!</> ❤️
+
+If you are new to Typst, <s>start with the tutorial</> at \
+<u>https://typst.app/docs/tutorial/</>. To get a quick start with your first \
+project, <s>choose a template</> on <u>https://typst.app/universe/</>.
+
+Here are the <s>most important commands</> you will be using:
+
+- Compile a file once: <c!>typst compile file.typ</>
+- Compile a file on every change: <c!>typst watch file.typ</>
+- Set up a project from a template: <c!>typst init @preview/<<TEMPLATE>></>
+
+Learn more about these commands by running <c!>typst help</>.
+
+If you have a question, we and our community would be glad to help you out on \
+the <s>Typst Forum</> at <u>https://forum.typst.app/</>.
+
+Happy Typsting!
+");
+
+/// Greets (and exists) if not yet greeted.
+pub fn greet() {
+    let Some(data_dir) = dirs::data_dir() else { return };
+    let path = data_dir.join("typst").join("greeted");
+
+    let prev_greet = std::fs::read_to_string(&path).ok();
+    if prev_greet.as_deref() == Some(crate::typst_version()) {
+        return;
+    };
+
+    std::fs::write(&path, crate::typst_version()).ok();
+    print_and_exit(GREETING);
+}
+
+/// Prints a colorized and line-wrapped message.
+fn print_and_exit(message: &'static str) -> ! {
+    // Abuse clap for line wrapping ...
+    let err = clap::Command::new("typst")
+        .max_term_width(80)
+        .help_template("{about}")
+        .about(message)
+        .try_get_matches_from(["typst", "--help"])
+        .unwrap_err();
+    let _ = err.print();
+
+    // Windows users might have double-clicked the .exe file and have no chance
+    // to read it before the terminal closes.
+    if cfg!(windows) {
+        pause();
+    }
+
+    std::process::exit(err.exit_code());
+}
+
+/// Waits for the user.
+#[allow(clippy::unused_io_amount)]
+fn pause() {
+    eprintln!();
+    eprintln!("Press enter to continue...");
+    io::stdin().lock().read(&mut [0]).unwrap();
+}

crates/typst-cli/src/greet.rs

@@ -2,6 +2,7 @@ mod args;
 mod compile;
 mod download;
 mod fonts;
+mod greet;
 mod init;
 mod package;
 mod query;
@@ -16,6 +17,7 @@ use std::cell::Cell;
 use std::io::{self, Write};
 use std::process::ExitCode;
 
+use clap::error::ErrorKind;
 use clap::Parser;
 use codespan_reporting::term;
 use codespan_reporting::term::termcolor::WriteColor;
@@ -30,8 +32,15 @@ thread_local! {
     static EXIT: Cell<ExitCode> = const { Cell::new(ExitCode::SUCCESS) };
 }
 
-/// The parsed commandline arguments.
-static ARGS: Lazy<CliArguments> = Lazy::new(CliArguments::parse);
+/// The parsed command line arguments.
+static ARGS: Lazy<CliArguments> = Lazy::new(|| {
+    CliArguments::try_parse().unwrap_or_else(|error| {
+        if error.kind() == ErrorKind::DisplayHelpOnMissingArgumentOrSubcommand {
+            crate::greet::greet();
+        }
+        error.exit();
+    })
+});
 
 /// Entry point.
 fn main() -> ExitCode {