PM: merge A3 follow-ups: registry-derived command lists, MERGE_MSG prefill, gutter fix, git.ignore, BOM
Some checks are pending
ci / ci (macos-15) (push) Waiting to run
ci / ci (ubuntu-24.04) (push) Waiting to run
ci / ci (windows-2025) (push) Waiting to run

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
danny 2026-10-31 14:52:03 +01:00
commit 83aeec68c0
47 changed files with 1161 additions and 269 deletions

View file

@ -53,3 +53,8 @@ impl Command for Quit {
Ok(Outcome::effect(Effect::Quit))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["app.about", "app.quit"];

View file

@ -258,3 +258,9 @@ impl Command for List {
Ok(Outcome::value(Value::Array(list)))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] =
&["buffer.close", "buffer.edit", "buffer.get", "buffer.list"];

View file

@ -201,3 +201,8 @@ impl Command for SaveAll {
))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["file.open", "file.save", "file.saveAll"];

View file

@ -955,6 +955,21 @@ impl Command for CreateBranch {
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"git.branches",
"git.checkout",
"git.commit",
"git.createBranch",
"git.lastMessage",
"git.show",
"git.stage",
"git.status",
"git.unstage",
];
#[cfg(test)]
mod tests {
use super::*;

View file

@ -114,3 +114,8 @@ impl Command for Blame {
)
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["git.blame"];

View file

@ -0,0 +1,80 @@
//! `git.ignore` (C7 A3): adds literal patterns for chosen files to the
//! work tree's `.gitignore`, on top of `lutra_vcs::Repo::ignore`.
//!
//! It runs through [`super::git::start_with`] like the other `git.*`
//! commands and sends `gitChanged` afterwards, since the status changes.
use serde::Deserialize;
use serde_json::{Value, json};
use super::git::{rel_path, start_with};
use super::params::parse;
use crate::{Command, CommandSpec, EngineError, Outcome, Registry, State};
/// Most paths one call takes.
const MAX_PATHS: usize = 10_000;
/// Registers `git.ignore`.
///
/// # Errors
/// [`EngineError::Internal`] if the id is taken.
pub fn register(registry: &mut Registry) -> Result<(), EngineError> {
registry.register(Box::new(Ignore))
}
/// Params of `git.ignore`.
#[derive(Debug, Deserialize)]
#[serde(deny_unknown_fields)]
struct IgnoreParams {
/// Project-relative or absolute paths inside the project.
paths: Vec<String>,
}
/// `git.ignore`.
struct Ignore;
impl Command for Ignore {
fn spec(&self) -> &CommandSpec {
&CommandSpec {
id: "git.ignore",
label: "Git: Add to .gitignore",
menu_path: None,
default_shortcut: None,
params: "{ paths: [path inside the project] } (1 to 10000); appends one literal pattern per path to the .gitignore at the work tree's root (created when missing): anchored with /, with \\ * ? [ and trailing spaces escaped, so it matches exactly that file or folder; returns { patterns: [added pattern] }, leaving out patterns already in the file",
}
}
fn enabled(&self, state: &State) -> bool {
state.has_project()
}
fn run(&self, state: &mut State, params: Value) -> Result<Outcome, EngineError> {
let command = self.spec().id;
let p: IgnoreParams = parse(command, params)?;
if p.paths.is_empty() || p.paths.len() > MAX_PATHS {
return Err(EngineError::invalid_params(
command,
format!("paths takes 1 to {MAX_PATHS} entries"),
));
}
let paths = p
.paths
.iter()
.map(|path| rel_path(state, command, path))
.collect::<Result<Vec<_>, _>>()?;
start_with(
state,
command,
true,
Box::new(move |repo| {
let patterns = repo.ignore(&paths)?;
Ok(json!({ "patterns": patterns }))
}),
)
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["git.ignore"];

View file

@ -449,6 +449,11 @@ impl Command for LineChanges {
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["git.lineChanges"];
#[cfg(test)]
mod tests {
use super::*;

View file

@ -221,3 +221,8 @@ impl Command for ShowAt {
)
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["git.log", "git.showAt", "git.showCommit"];

View file

@ -1,5 +1,5 @@
//! Merge commands (M4.8): `git.merge`, `git.mergeAbort`,
//! `git.conflictVersions` and `git.markResolved`, on top of
//! `git.conflictVersions`, `git.markResolved` and `git.mergeMessage`, on top of
//! `lutra_vcs::Repo`'s merge calls.
//!
//! Each runs through [`super::git::start_with`]: a pending outcome, git and
@ -25,6 +25,7 @@ pub fn register(registry: &mut Registry) -> Result<(), EngineError> {
registry.register(Box::new(MergeAbort))?;
registry.register(Box::new(ConflictVersionsCommand))?;
registry.register(Box::new(MarkResolved))?;
registry.register(Box::new(MergeMessage))?;
Ok(())
}
@ -112,6 +113,36 @@ impl Command for MergeAbort {
}
}
/// `git.mergeMessage`.
struct MergeMessage;
impl Command for MergeMessage {
fn spec(&self) -> &CommandSpec {
&CommandSpec {
id: "git.mergeMessage",
label: "Git: Prepared Merge Message",
menu_path: None,
default_shortcut: None,
params: "none; returns { message: string | null }: the message git prepared for the merge in progress (MERGE_MSG without its # comment lines), null when no merge is in progress; for prefilling the commit box",
}
}
fn enabled(&self, state: &State) -> bool {
state.has_project()
}
fn run(&self, state: &mut State, params: Value) -> Result<Outcome, EngineError> {
let command = self.spec().id;
let _: serde_json::Map<String, Value> = parse(command, params)?;
start_with(
state,
command,
false,
Box::new(|repo| Ok(json!({ "message": repo.merge_message()? }))),
)
}
}
/// Params of `git.conflictVersions`.
#[derive(Debug, Deserialize)]
#[serde(deny_unknown_fields)]
@ -208,3 +239,14 @@ impl Command for MarkResolved {
)
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"git.conflictVersions",
"git.markResolved",
"git.merge",
"git.mergeAbort",
"git.mergeMessage",
];

View file

@ -699,3 +699,18 @@ impl Command for RemoteRemove {
start(state, command, Op::Remove(p.name))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"git.cancel",
"git.clone",
"git.fetch",
"git.pull",
"git.push",
"git.remoteAdd",
"git.remoteRemove",
"git.remoteSetUrl",
"git.remotes",
];

View file

@ -219,3 +219,13 @@ impl Command for StashDrop {
)
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"git.stash",
"git.stashApply",
"git.stashDrop",
"git.stashList",
];

View file

@ -516,3 +516,8 @@ fn symbol_item(hit: &SymbolHit<'_>, container: bool) -> Value {
}
item
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["goto.class", "goto.file", "goto.symbol", "index.status"];

View file

@ -841,6 +841,11 @@ fn cap(text: &str, max: usize) -> String {
text.get(..end).unwrap_or("").to_string()
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["lsp.completion", "lsp.hover", "lsp.signatureHelp"];
#[cfg(test)]
mod tests {
use serde_json::json;

View file

@ -135,3 +135,9 @@ impl Command for Log {
Ok(Outcome::value(json!({ "lines": state.lsp.log() })))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] =
&["diagnostics.list", "lsp.log", "lsp.restart", "lsp.status"];

View file

@ -781,6 +781,16 @@ fn notify_summary(state: &mut State, new_name: &str, applied: &edit::Applied) {
);
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"lsp.definition",
"lsp.prepareRename",
"lsp.references",
"lsp.rename",
];
#[cfg(test)]
mod tests {
use super::*;

View file

@ -5,6 +5,7 @@ mod buffer;
mod file;
pub mod git;
pub mod git_blame;
pub mod git_ignore;
pub mod git_lines;
pub mod git_log;
pub mod git_merge;
@ -78,5 +79,37 @@ pub fn register_builtins(registry: &mut Registry) -> Result<(), EngineError> {
git_remote::register(registry)?;
git_merge::register(registry)?;
git_stash::register(registry)?;
git_ignore::register(registry)?;
Ok(())
}
/// The id lists of every module that registers built-in commands, one entry
/// per module. Each module keeps its own list next to its commands, so new
/// commands in different modules never touch the same lines.
#[cfg(test)]
pub(crate) const BUILTIN_COMMAND_IDS: &[&[&str]] = &[
app::COMMAND_IDS,
buffer::COMMAND_IDS,
file::COMMAND_IDS,
git::COMMAND_IDS,
git_blame::COMMAND_IDS,
git_ignore::COMMAND_IDS,
git_lines::COMMAND_IDS,
git_log::COMMAND_IDS,
git_merge::COMMAND_IDS,
git_remote::COMMAND_IDS,
git_stash::COMMAND_IDS,
goto::COMMAND_IDS,
lsp_assist::COMMAND_IDS,
lsp_diagnostics::COMMAND_IDS,
lsp_nav::COMMAND_IDS,
project::COMMAND_IDS,
recovery::COMMAND_IDS,
search::COMMAND_IDS,
settings::COMMAND_IDS,
syntax::COMMAND_IDS,
terminal::COMMAND_IDS,
theme::COMMAND_IDS,
toolchain::COMMAND_IDS,
ui::COMMAND_IDS,
];

View file

@ -230,3 +230,13 @@ impl Command for Children {
})))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"project.children",
"project.close",
"project.open",
"project.openDialog",
];

View file

@ -204,3 +204,8 @@ impl Command for Discard {
Ok(Outcome::value(json!({ "discarded": discarded })))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["recovery.discard", "recovery.list", "recovery.restore"];

View file

@ -302,3 +302,8 @@ impl From<lutra_search::Match> for SearchMatch {
}
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["search.cancel", "search.find"];

View file

@ -167,3 +167,13 @@ fn finish(
.ok_or_else(|| EngineError::Internal(format!("setting vanished: {key}")))?;
Ok(Outcome::value(json!({ "value": value })))
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"settings.get",
"settings.list",
"settings.reset",
"settings.set",
];

View file

@ -581,6 +581,11 @@ impl Command for OutlineCommand {
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["syntax.outline"];
#[cfg(test)]
mod tests {
use super::*;

View file

@ -400,6 +400,16 @@ pub fn pump(state: &mut State) {
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &[
"terminal.close",
"terminal.create",
"terminal.input",
"terminal.resize",
];
#[cfg(test)]
mod tests {
use serde_json::json;

View file

@ -100,3 +100,8 @@ impl Command for SystemPreference {
Ok(Outcome::value(Value::Object(fields)))
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["theme.list", "theme.systemPreference"];

View file

@ -639,6 +639,11 @@ impl Command for DownloadPhpactor {
}
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["toolchain.downloadPhpactor", "toolchain.status"];
#[cfg(test)]
mod tests {
use std::io::{Read, Write};

View file

@ -182,6 +182,11 @@ pub fn dispatch(state: &mut State, id: &str, params: Value) -> Option<Outcome> {
Some(Outcome::value(Value::Null))
}
/// The ids of the commands this module registers, checked against the
/// registry by the engine's listing test. Add a new command's id here.
#[cfg(test)]
pub(crate) const COMMAND_IDS: &[&str] = &["ui.registerCommands"];
#[cfg(test)]
mod tests {
use super::valid_id;

View file

@ -467,91 +467,23 @@ mod tests {
let mut engine = Engine::new().unwrap();
engine.register(Box::new(Disabled)).unwrap();
let list = engine.list_commands();
let ids: Vec<_> = list.iter().map(|c| c.id.as_str()).collect();
assert_eq!(
ids,
vec![
"app.about",
"app.quit",
"buffer.close",
"buffer.edit",
"buffer.get",
"buffer.list",
"diagnostics.list",
"file.open",
"file.save",
"file.saveAll",
"git.blame",
"git.branches",
"git.cancel",
"git.checkout",
"git.clone",
"git.commit",
"git.conflictVersions",
"git.createBranch",
"git.fetch",
"git.lastMessage",
"git.lineChanges",
"git.log",
"git.markResolved",
"git.merge",
"git.mergeAbort",
"git.pull",
"git.push",
"git.remoteAdd",
"git.remoteRemove",
"git.remoteSetUrl",
"git.remotes",
"git.show",
"git.showAt",
"git.showCommit",
"git.stage",
"git.stash",
"git.stashApply",
"git.stashDrop",
"git.stashList",
"git.status",
"git.unstage",
"goto.class",
"goto.file",
"goto.symbol",
"index.status",
"lsp.completion",
"lsp.definition",
"lsp.hover",
"lsp.log",
"lsp.prepareRename",
"lsp.references",
"lsp.rename",
"lsp.restart",
"lsp.signatureHelp",
"lsp.status",
"project.children",
"project.close",
"project.open",
"project.openDialog",
"recovery.discard",
"recovery.list",
"recovery.restore",
"search.cancel",
"search.find",
"settings.get",
"settings.list",
"settings.reset",
"settings.set",
"syntax.outline",
"terminal.close",
"terminal.create",
"terminal.input",
"terminal.resize",
"test.disabled",
"theme.list",
"theme.systemPreference",
"toolchain.downloadPhpactor",
"toolchain.status",
"ui.registerCommands",
]
let ids: Vec<&str> = list.iter().map(|c| c.id.as_str()).collect();
let mut sorted = ids.clone();
sorted.sort_unstable();
assert_eq!(ids, sorted, "the listing is sorted by id");
let mut expected: Vec<&str> = cmd::BUILTIN_COMMAND_IDS
.iter()
.flat_map(|ids| ids.iter().copied())
.chain(["test.disabled"])
.collect();
expected.sort_unstable();
let missing: Vec<_> = expected.iter().filter(|id| !ids.contains(id)).collect();
let extra: Vec<_> = ids.iter().filter(|id| !expected.contains(id)).collect();
assert!(
missing.is_empty() && extra.is_empty(),
"registered but not in a module's COMMAND_IDS: {extra:?}; listed in COMMAND_IDS but not registered: {missing:?}"
);
assert_eq!(ids, expected, "no id is listed twice");
let by_id = |id: &str| list.iter().find(|c| c.id == id).unwrap();
let quit = by_id("app.quit");
assert_eq!(quit.default_shortcut.as_deref(), Some("Mod+Q"));

View file

@ -1,7 +1,7 @@
//! The merge commands through the engine with pending outcomes:
//! `git.merge` up to date, with conflicts and refused; `git.conflictVersions`;
//! `git.markResolved` and `git.mergeAbort`, each followed by `gitChanged`;
//! bad params. Skips with a message when git is not installed.
//! `git.mergeMessage`; `git.ignore` (C7 A3); bad params. Skips with a message when git is not installed.
#![allow(
clippy::unwrap_used,
@ -147,11 +147,21 @@ fn merge_conflict_versions_resolve_and_abort() {
);
assert_eq!(host.git_changes(), 0);
let prepared = host.run("git.mergeMessage", Value::Null).unwrap();
let text = prepared["message"].as_str().unwrap();
assert!(text.starts_with("Merge branch 'feature'"), "{text}");
assert!(!text.contains('#'), "{text}");
assert_eq!(host.git_changes(), 0);
let again = host.run("git.merge", json!({"branch": "feature"}));
assert!(matches!(again, Err(EngineError::Failed(m)) if m.contains("in progress")));
host.run("git.mergeAbort", Value::Null).unwrap();
assert_eq!(host.git_changes(), 1);
assert_eq!(
host.run("git.mergeMessage", Value::Null).unwrap(),
json!({"message": null})
);
assert_eq!(
std::fs::read_to_string(root.join("a.php")).unwrap(),
"<?php\nmain\n"
@ -188,6 +198,8 @@ fn bad_params_and_no_project() {
("git.merge", json!({"branch": "-x"})),
("git.markResolved", json!({"paths": []})),
("git.conflictVersions", json!({"path": 3})),
("git.ignore", json!({"paths": []})),
("git.ignore", json!({"paths": ["../x"]})),
] {
assert!(
matches!(
@ -206,3 +218,32 @@ fn bad_params_and_no_project() {
Err(EngineError::Disabled(_))
));
}
#[test]
fn ignore_appends_a_literal_pattern_and_refreshes() {
if !have_git() {
return;
}
let dir = tempfile::tempdir().unwrap();
let root = dir.path();
conflicting(root);
std::fs::write(root.join("debug[1].log"), "x").unwrap();
std::fs::write(root.join("debug1.log"), "x").unwrap();
let host = Host::open(root);
host.git_changes();
let out = host
.run("git.ignore", json!({"paths": ["debug[1].log"]}))
.unwrap();
assert_eq!(out["patterns"].as_array().unwrap().len(), 1);
assert_eq!(host.git_changes(), 1);
let status = host.run("git.status", Value::Null).unwrap();
let paths: Vec<&str> = status["files"]
.as_array()
.unwrap()
.iter()
.map(|f| f["path"].as_str().unwrap())
.collect();
assert!(paths.contains(&"debug1.log"), "{paths:?}");
assert!(paths.contains(&".gitignore"), "{paths:?}");
assert!(!paths.contains(&"debug[1].log"), "{paths:?}");
}