{"header":{"message":"Refactor argument handling into a separate file","description":"This is almost a complete re-write of the argument handling code, with everything being much more robust than before. This version is also much more idiomatic Xilem code than before, and hopefully that will continue to improve over time, with message-handling being the next obvious step.","timestamp":"2023-11-18T14:23:06.841100688Z","authors":[{}]},"hash":"MIY7QPYK3EZTOGZF5PWU2ZKM7NG5ANWKNHS56FVTOY7PPATWLSSAC","authors":[{"login":"finchie","key":"6WCsL9cxQoPBLLwR1PUvmFBJi6wGTGFAxcxMovPQCwTZ"}],"deps":{"hashes":[["MIY7QPYK3EZTOGZF5PWU2ZKM7NG5ANWKNHS56FVTOY7PPATWLSSAC","Refactor argument handling into a separate file"],["AA",null],["G54GZBS464DFT2224SUTRWPRRSLUQKWDXY2YA7USW7UZ7VPXIHEAC","Remove dependency on clap patches"],["C73UJ7ZYG4EE3YTK3N66GXPNWJHEBSRE4PDQBWMN6SKQ3U6ZYKXAC","Create simple `xilem_html` demo"],["4MMVEN5YUVUQ5RO3X2XKZVBMBMHOEJIYUCLKL63EPRUVQQRQXUAAC","Move generated docs inside of parent `docs` module"],["JFJVY57RWKT6YJ62MWWOHXSLASLWPORFUGF67TVTW4FW7XBZEAUQC","List `clap` argument IDs"],["REI53XR4WDH5EKLTXTFVTOVWCCFRWTFH4GQS6DSNM5LSRFTX7HJQC","Render argument state as HTML"],["ZYNEMGAZXWHIWGNPB2RTYG3JWTH5Y5XY4JWJ3TTPANIOORTCLISAC","Use generated Typst code from Rust"],["BMG4FSHNV54VXDHNUVGZOMXQJWLFSUF3M5NCN7GJETNIF3QTHELQC","Add basic `clap` support"],["A4E5KLI2CEHJLO6WUME2VIXPK4C2DXHCBVEK2TJTLHGCRCZ2ZC7QC","Turn arguments into sidebar"],["BSJYWOYSJRERQ45AD7RN3364RYQ5P3IM76S67262VLFZPFO3B5JQC","Implement MVP Typst embedding"]],"deps":["G54GZBS464DFT2224SUTRWPRRSLUQKWDXY2YA7USW7UZ7VPXIHEAC"],"known":["C73UJ7ZYG4EE3YTK3N66GXPNWJHEBSRE4PDQBWMN6SKQ3U6ZYKXAC","BMG4FSHNV54VXDHNUVGZOMXQJWLFSUF3M5NCN7GJETNIF3QTHELQC","JFJVY57RWKT6YJ62MWWOHXSLASLWPORFUGF67TVTW4FW7XBZEAUQC","REI53XR4WDH5EKLTXTFVTOVWCCFRWTFH4GQS6DSNM5LSRFTX7HJQC","A4E5KLI2CEHJLO6WUME2VIXPK4C2DXHCBVEK2TJTLHGCRCZ2ZC7QC","BSJYWOYSJRERQ45AD7RN3364RYQ5P3IM76S67262VLFZPFO3B5JQC","ZYNEMGAZXWHIWGNPB2RTYG3JWTH5Y5XY4JWJ3TTPANIOORTCLISAC","4MMVEN5YUVUQ5RO3X2XKZVBMBMHOEJIYUCLKL63EPRUVQQRQXUAAC"]},"hunks":[{"Edit":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":1,"atom":{"NewVertex":{"up_context":[{"change":3,"pos":49}],"down_context":[{"change":2,"pos":0}],"flag":"BLOCK","start":0,"end":13,"inode":{"change":3,"pos":49}}},"contents":[{"Add":"pub mod arg;"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":4,"ins":{"up_context":[{"change":3,"pos":70}],"down_context":[{"change":3,"pos":123}],"flag":"BLOCK","start":14,"end":63,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":70},"to":{"change":2,"start":14,"end":99},"introduced_by":2}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":"use clap::{ArgMatches, Command, CommandFactory};"}],"del_contents":[{"Del":"use clap::parser::ValueSource;\nuse clap::{value_parser, ArgMatches, CommandFactory};\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":6,"ins":{"up_context":[{"change":3,"pos":141}],"down_context":[{"change":3,"pos":0}],"flag":"BLOCK","start":64,"end":133,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":141},"to":{"change":2,"start":100,"end":181},"introduced_by":2}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":"use xilem_html::{document_body, elements as el, App, View, ViewExt};"}],"del_contents":[{"Del":"use xilem_html::{document_body, elements as el, App, View, ViewExt, ViewMarker};\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":10,"ins":{"up_context":[{"change":3,"pos":190}],"down_context":[{"change":2,"pos":182}],"flag":"BLOCK","start":134,"end":197,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":209},"to":{"change":3,"start":209,"end":248},"introduced_by":3}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":"pub struct AppState {"},{"Add":" input: String,"},{"Add":" command: Command,"}],"del_contents":[{"Del":"struct AppState {\n command: String,\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":19,"ins":{"up_context":[{"change":2,"pos":303}],"down_context":[{"change":2,"pos":339}],"flag":"BLOCK","start":198,"end":273,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":2,"pos":303},"to":{"change":2,"start":303,"end":339},"introduced_by":2}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":" input: String::new(),"},{"Add":" command: MockApp::command(),"}],"del_contents":[{"Del":" command: String::new(),\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":28,"ins":{"up_context":[{"change":3,"pos":323}],"down_context":[{"change":3,"pos":367}],"flag":"BLOCK","start":274,"end":308,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":323},"to":{"change":3,"start":323,"end":359},"introduced_by":3}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":" self.input = new_command;"}],"del_contents":[{"Del":" self.command = new_command;\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":31,"ins":{"up_context":[{"change":3,"pos":243}],"down_context":[{"change":3,"pos":109}],"flag":"BLOCK","start":309,"end":356,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":243},"to":{"change":3,"start":243,"end":292},"introduced_by":3}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":" let args_iter = self.input.split(' ');"}],"del_contents":[{"Del":" let args_iter = self.command.split(' ');\n"}]}},{"Edit":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":37,"atom":{"EdgeMap":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":577},"to":{"change":3,"start":577,"end":579},"introduced_by":3},{"previous":"","flag":"DELETED","from":{"change":3,"pos":685},"to":{"change":3,"start":280,"end":281},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":280},"to":{"change":3,"start":280,"end":281},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":281},"to":{"change":2,"start":576,"end":1061},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":1061},"to":{"change":3,"start":631,"end":632},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":631},"to":{"change":3,"start":631,"end":632},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":632},"to":{"change":2,"start":1062,"end":1257},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":1257},"to":{"change":3,"start":1347,"end":1354},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1347},"to":{"change":3,"start":1347,"end":1354},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1354},"to":{"change":2,"start":1258,"end":1259},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":1259},"to":{"change":3,"start":1354,"end":1368},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1354},"to":{"change":3,"start":1354,"end":1368},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1368},"to":{"change":2,"start":1260,"end":1378},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":1378},"to":{"change":3,"start":1570,"end":1611},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1570},"to":{"change":3,"start":1570,"end":1611},"introduced_by":3},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1611},"to":{"change":2,"start":1379,"end":1802},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":1802},"to":{"change":3,"start":1710,"end":1766},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1710},"to":{"change":3,"start":1710,"end":1766},"introduced_by":3}],"inode":{"change":3,"pos":49}}},"contents":[{"Del":"}\n"},{"Del":"\n"},{"Del":"fn arg_item(matches: &ArgMatches, arg: &clap::Arg) -> impl View + ViewMarker {\n tracing::debug!(\"`{:?}`\", matches.contains_id(\"name\"));\n let source = if let Some(source) = matches.value_source(arg.get_id().as_str()) {\n match source {\n ValueSource::DefaultValue => \"default\",\n ValueSource::EnvVariable => \"environment\",\n ValueSource::CommandLine => \"cmdline\",\n _ => \"todo\",\n }\n } else {\n \"none\"\n };\n"},{"Del":"\n"},{"Del":" let type_id = arg.get_value_parser().type_id();\n let type_name = if type_id == value_parser!(String).type_id() {\n \"string\".to_string()\n } else {\n format!(\"{:?}\", type_id)\n"},{"Del":" };\n"},{"Del":"\n"},{"Del":" el::div((\n"},{"Del":" el::div((type_name, el::div(\"test\").attr(\"class\", \"hover_content\")))\n .attr(\"class\", \"hoverable\"),\n"},{"Del":" el::div(source),\n el::ul(\n"},{"Del":" matches\n .get_raw_occurrences(&arg.get_id().as_str())\n .unwrap_or_default()\n .map(|os_strings| {\n el::li({\n os_strings\n .map(|s| s.to_string_lossy().to_string())\n .collect::>()\n .join(\" \")\n })\n })\n"},{"Del":" .collect::>(),\n ),\n ))\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":40,"ins":{"up_context":[{"change":3,"pos":692}],"down_context":[{"change":3,"pos":722}],"flag":"BLOCK","start":357,"end":387,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":692},"to":{"change":3,"start":1767,"end":1797},"introduced_by":3}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":" let input = el::input(())"}],"del_contents":[{"Del":" let input = el::input(\"\")\n"}]}},{"Replacement":{"inode":{"change":3,"pos":49},"path":"src/main.rs","line":50,"ins":{"up_context":[{"change":3,"pos":921}],"down_context":[{"change":3,"pos":1003}],"flag":"BLOCK","start":388,"end":439,"inode":{"change":3,"pos":49}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":921},"to":{"change":2,"start":1973,"end":2286},"introduced_by":2},{"previous":"","flag":"DELETED","from":{"change":2,"pos":2286},"to":{"change":3,"start":172,"end":209},"introduced_by":2},{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":172},"to":{"change":3,"start":172,"end":209},"introduced_by":3}],"inode":{"change":3,"pos":49}},"ins_contents":[{"Add":" el::br(()),"},{"Add":" arg::args_view(state),"}],"del_contents":[{"Del":" el::div((el::div(\n MockApp::command()\n .get_opts()\n .filter(|arg| arg_matches.try_contains_id(arg.get_id().as_str()).is_ok())\n .map(|arg| arg_item(&arg_matches, arg))\n .collect::>(),\n )\n .attr(\"id\", \"sidebar\"),))\n"},{"Del":" .attr(\"class\", \"container\"),\n"}]}},{"Replacement":{"inode":{"change":3,"pos":503},"path":"src/cli.rs","line":8,"ins":{"up_context":[{"change":3,"pos":729}],"down_context":[{"change":3,"pos":753}],"flag":"BLOCK","start":440,"end":608,"inode":{"change":3,"pos":503}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":729},"to":{"change":3,"start":729,"end":753},"introduced_by":3}],"inode":{"change":3,"pos":503}},"ins_contents":[{"Add":" ///"},{"Add":" /// A longer explanation."},{"Add":" /// This explanation takes up multiple lines!"},{"Add":" /// Wow!"},{"Add":" #[arg(short = 'n', long, alias = \"nom\", env = \"NAME_ENV_VAR\")]"}],"del_contents":[{"Del":" #[arg(short, long)]\n"}]}},{"FileAdd":{"meta":{"basename":"arg.rs","metadata":0},"context":[{"change":3,"pos":15}],"contents":[{"Add":"use clap::parser::ValueSource;"},{"Add":"use clap::{value_parser, Arg};"},{"Add":"use xilem_html::{elements as el, Adapt, MessageResult, View, ViewMarker, ViewSequence};"},{"Add":""},{"Add":"use crate::AppState;"},{"Add":""},{"Add":"#[non_exhaustive]"},{"Add":"enum ArgType {"},{"Add":" String,"},{"Add":" Other,"},{"Add":"}"},{"Add":""},{"Add":"impl From<&Arg> for ArgType {"},{"Add":" fn from(value: &Arg) -> Self {"},{"Add":" let type_id = value.get_value_parser().type_id();"},{"Add":" if type_id == value_parser!(String).type_id() {"},{"Add":" Self::String"},{"Add":" } else {"},{"Add":" Self::Other"},{"Add":" }"},{"Add":" }"},{"Add":"}"},{"Add":""},{"Add":"fn type_description(arg: &Arg) -> impl View + ViewMarker {"},{"Add":" let supported_type_description = ArgType::from(arg);"},{"Add":" el::div(("},{"Add":" match supported_type_description {"},{"Add":" ArgType::String => \"string\","},{"Add":" ArgType::Other => \"other\","},{"Add":" },"},{"Add":" el::div(\"placeholder content\").attr(\"class\", \"hover_content\"),"},{"Add":" ))"},{"Add":" .attr(\"class\", \"hoverable\")"},{"Add":"}"},{"Add":""},{"Add":"fn env(arg: &Arg) -> impl ViewSequence {"},{"Add":" arg.get_env()"},{"Add":" .map(|variable| variable.to_string_lossy().to_string())"},{"Add":"}"},{"Add":""},{"Add":"fn aliases(arg: &Arg) -> impl ViewSequence {"},{"Add":" let aliases = if let Some(aliases) = arg.get_all_aliases() {"},{"Add":" aliases"},{"Add":" .iter()"},{"Add":" .map(|alias| alias.to_string())"},{"Add":" .filter(|alias| alias != arg.get_id())"},{"Add":" .collect::>()"},{"Add":" } else {"},{"Add":" // Ignore if there's no aliases"},{"Add":" return None;"},{"Add":" };"},{"Add":""},{"Add":" // Ignore if all aliases have been filtered out."},{"Add":" // This will usually happen when there is 1 alias returned by get_all_aliases,"},{"Add":" // which is the long argument version, which is equivalent to the argument id"},{"Add":" // and is therefore redundant"},{"Add":" if aliases.is_empty() {"},{"Add":" return None;"},{"Add":" }"},{"Add":""},{"Add":" Some(el::div(("},{"Add":" el::h4(\"Also known as:\"),"},{"Add":" el::ul(aliases.into_iter().map(el::li).collect::>>()),"},{"Add":" )))"},{"Add":"}"},{"Add":""},{"Add":"fn source(state: &AppState, arg: &Arg) -> impl View + ViewMarker {"},{"Add":" String::from(if let Ok(arg_matches) = state.arg_matches.as_ref() {"},{"Add":" if let Some(source) = arg_matches.value_source(arg.get_id().as_str()) {"},{"Add":" match source {"},{"Add":" ValueSource::DefaultValue => \"default\","},{"Add":" ValueSource::EnvVariable => \"environment\","},{"Add":" ValueSource::CommandLine => \"cmdline\","},{"Add":" _ => \"todo\","},{"Add":" }"},{"Add":" } else {"},{"Add":" \"none\""},{"Add":" }"},{"Add":" } else {"},{"Add":" \"error\""},{"Add":" })"},{"Add":"}"},{"Add":""},{"Add":"fn matched_values(state: &AppState, arg: &Arg) -> impl View + ViewMarker {"},{"Add":" el::ul("},{"Add":" state"},{"Add":" .arg_matches"},{"Add":" .as_ref()"},{"Add":" .iter()"},{"Add":" .map(|arg_matches| {"},{"Add":" arg_matches"},{"Add":" .get_raw_occurrences(&arg.get_id().as_str())"},{"Add":" .unwrap_or_default()"},{"Add":" .map(|os_strings| {"},{"Add":" el::li("},{"Add":" os_strings"},{"Add":" .map(|s| s.to_string_lossy().to_string())"},{"Add":" .collect::>()"},{"Add":" .join(\" \"),"},{"Add":" )"},{"Add":" })"},{"Add":" })"},{"Add":" .flatten()"},{"Add":" .collect::>>(),"},{"Add":" )"},{"Add":"}"},{"Add":""},{"Add":"fn item(state: &AppState, arg: &Arg) -> impl View + ViewMarker {"},{"Add":" el::div(("},{"Add":" // Name of the argument"},{"Add":" el::h3(arg.get_id().to_string().to_uppercase()),"},{"Add":" // The argument's type info"},{"Add":" type_description(arg),"},{"Add":" el::br(()),"},{"Add":" // Alternate sources"},{"Add":" el::div((env(arg), aliases(arg))),"},{"Add":" // Hand-written documentation"},{"Add":" el::div(("},{"Add":" // One-line short help"},{"Add":" arg.get_help()"},{"Add":" .map(|short_help| el::i(short_help.to_string())),"},{"Add":" el::br(()),"},{"Add":" // Long-form help"},{"Add":" arg.get_long_help()"},{"Add":" .map(|long_help| el::q(long_help.to_string())),"},{"Add":" )),"},{"Add":" // Source location (defaults, command line etc)"},{"Add":" source(state, arg),"},{"Add":" // Number of allowed arguments"},{"Add":" arg.get_num_args().map(|arg_range| arg_range.to_string()),"},{"Add":" // Matched values"},{"Add":" matched_values(state, arg),"},{"Add":" ))"},{"Add":"}"},{"Add":""},{"Add":"pub fn args_view(state: &mut AppState) -> impl View + ViewMarker {"},{"Add":" el::div(if state.arg_matches.is_ok() {"},{"Add":" state"},{"Add":" .command"},{"Add":" .get_opts()"},{"Add":" .map(|arg| {"},{"Add":" Adapt::new("},{"Add":" |_state, _thunk| {"},{"Add":" // TODO: actually re-compute this value"},{"Add":" MessageResult::Nop"},{"Add":" },"},{"Add":" item(state, arg),"},{"Add":" )"},{"Add":" })"},{"Add":" .collect::>()"},{"Add":" } else {"},{"Add":" Vec::new()"},{"Add":" })"},{"Add":" .attr(\"id\", \"sidebar\")"},{"Add":"}"}]}},{"Replacement":{"inode":{"change":3,"pos":1280},"path":"Cargo.toml","line":10,"ins":{"up_context":[{"change":3,"pos":1345}],"down_context":[{"change":3,"pos":1345}],"flag":"BLOCK","start":5292,"end":5351,"inode":{"change":3,"pos":1280}},"del":{"edges":[{"previous":"BLOCK","flag":"BLOCK | DELETED","from":{"change":3,"pos":1345},"to":{"change":2,"start":2287,"end":2364},"introduced_by":2}],"inode":{"change":3,"pos":1280}},"ins_contents":[{"Add":"clap = { version = \"4.4.8\", features = [\"derive\", \"env\"] }"}],"del_contents":[{"Del":"clap = { version = \"4.4.8\", features = [\"derive\"] }\n# clap_builder = \"4.4.8\"\n"}]}}],"owner":"finchie","repo":"new_manual","token":"IFPLfclhQjCvwdrmWfnWgO3AeLRpDrQ8vVQedmcJteI=","login":null}

…

Dependencies

Change contents