Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ on:
permissions:
contents: write

concurrency:
group: release
cancel-in-progress: false

jobs:
release:
name: Release
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ on:
workflow_dispatch:
workflow_call:

concurrency:
group: test-${{ github.ref }}
cancel-in-progress: true

jobs:
test:
runs-on: windows-latest
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## [0.4.1-dev.1](https://github.com/IMXEren/cuc/compare/v0.4.0...v0.4.1-dev.1) (2026-09-30)

### 🐛 Bug Fixes

* emit generated Lua functions in deterministic order ([81fe32a](https://github.com/IMXEren/cuc/commit/81fe32ad3497c44d2f87e70072999ab1a4d1820d))
* report Usage parse error details and source locations ([3811b57](https://github.com/IMXEren/cuc/commit/3811b57c6ffb9352588fcd0679671018202dd0d2))
* serialize release workflow runs ([2dda198](https://github.com/IMXEren/cuc/commit/2dda198f28bb2a419d016405e77a805cf7dae991))
* upgrade Usage dependencies to v6.12.0 ([aeeec6a](https://github.com/IMXEren/cuc/commit/aeeec6a743b16fac8a61f4c667888153e545ca8b))

## [0.4.0](https://github.com/IMXEren/cuc/compare/v0.3.0...v0.4.0) (2026-09-16)

### ✨ New Features
Expand Down
26 changes: 16 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions bin/cuc/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "cuc-cli"
version = "0.4.0"
version = "0.4.1-dev.1"
edition = "2024"
description = "A CLI tool to generate clink argmatcher completions from the usage spec."
authors = { workspace = true }
Expand All @@ -19,8 +19,8 @@ anyhow = "1.0.104"
base64 = "0.23.1"
clap = { version = "4.6.6", features = ["derive"] }
cuc-lib = { workspace = true }
clap_usage = { git = "https://github.com/jdx/usage", tag = "v6.9.0" }
usage = { package = "usage-lib", git = "https://github.com/jdx/usage", tag = "v6.9.0", default-features = false }
clap_usage = { git = "https://github.com/jdx/usage", tag = "v6.12.0" }
usage = { package = "usage-lib", git = "https://github.com/jdx/usage", tag = "v6.12.0", default-features = false }
kdl = "6"
indexmap = "2.13.0"
tera = "2"
Expand Down
110 changes: 107 additions & 3 deletions bin/cuc/src/cli/generate/generator.rs
Original file line number Diff line number Diff line change
Expand Up @@ -470,14 +470,20 @@ end
script_body += &arg_match_register_completion;
}

for func in self.cached_functions.values() {
script_start += func;
}
Self::append_cached_functions(self.cached_functions, &mut script_start);

script_start += &script_body;
script_start
}

fn append_cached_functions(cached_functions: &HashMap<String, String>, out: &mut String) {
let mut functions: Vec<_> = cached_functions.iter().collect();
functions.sort_by_key(|(name, _)| *name);
for (_, function) in functions {
out.push_str(function);
}
}

fn function_ref(name: impl AsRef<str>) -> String {
format!("{GENERATED_FUNCTION_TABLE}.{}", name.as_ref())
}
Expand Down Expand Up @@ -1999,6 +2005,104 @@ mod tests {
.generate()
}

#[test]
fn cached_functions_emit_in_name_order_regardless_of_insertion() {
let mut forward = HashMap::new();
forward.insert("_cuc.b".to_string(), "function _cuc.b() end\n".to_string());
forward.insert("_cuc.a".to_string(), "function _cuc.a() end\n".to_string());
forward.insert("_cuc.c".to_string(), "function _cuc.c() end\n".to_string());

let mut backward = HashMap::new();
backward.insert("_cuc.c".to_string(), "function _cuc.c() end\n".to_string());
backward.insert("_cuc.a".to_string(), "function _cuc.a() end\n".to_string());
backward.insert("_cuc.b".to_string(), "function _cuc.b() end\n".to_string());

let mut forward_out = String::new();
GeneratorView::append_cached_functions(&forward, &mut forward_out);
let mut backward_out = String::new();
GeneratorView::append_cached_functions(&backward, &mut backward_out);

assert_eq!(forward_out, backward_out);
assert_eq!(
forward_out,
"function _cuc.a() end\nfunction _cuc.b() end\nfunction _cuc.c() end\n"
);
}

#[test]
fn identical_specs_generate_identical_lua() {
let spec = UsageSpec {
info: Info {
name: "demo".into(),
bin: "demo".into(),
},
flags: vec![
Flag {
name: "verbose".into(),
names: vec!["--verbose".into()],
..Default::default()
},
Flag {
name: "output".into(),
names: vec!["--output".into()],
arg: Some(Arg {
name: "output".into(),
repr: "<output>".into(),
..Default::default()
}),
..Default::default()
},
],
cmds: vec![
Cmd {
name: "add".into(),
args: vec![Arg {
name: "task".into(),
repr: "<task>".into(),
..Default::default()
}],
..Default::default()
},
Cmd {
name: "remove".into(),
args: vec![Arg {
name: "name".into(),
repr: "<name>".into(),
..Default::default()
}],
..Default::default()
},
Cmd {
name: "list".into(),
args: vec![Arg {
name: "filter".into(),
repr: "<filter>".into(),
..Default::default()
}],
..Default::default()
},
],
..Default::default()
};

let first = generate(spec.clone());
let second = generate(spec);

assert_eq!(first, second);

// The emitted `_cuc` fields are in name order, not hash order.
let names = first
.lines()
.filter_map(|line| line.strip_prefix("function "))
.filter_map(|line| line.split('(').next())
.filter(|name| name.starts_with("_cuc."))
.collect::<Vec<_>>();
assert!(names.len() > 1);
let mut sorted = names.clone();
sorted.sort_unstable();
assert_eq!(names, sorted);
}

#[test]
fn links_unknown_first_word_to_default_subcommand() {
let spec = UsageSpec {
Expand Down
Loading