Cameron Mcloughlin
192f33759b
Changes the list of words used when generating random worktree names to avoid anything even tangentially related to software engineering. Release Notes: - N/A or Added/Fixed/Improved ...
172 lines
8.1 KiB
Rust
172 lines
8.1 KiB
Rust
use collections::HashSet;
|
|
use rand::Rng;
|
|
|
|
const ADJECTIVES: &[&str] = &[
|
|
"able", "agate", "airy", "alpine", "amber", "ample", "aqua", "arctic", "arid", "ashen",
|
|
"astral", "autumn", "avid", "balmy", "birch", "bold", "boreal", "brave", "breezy", "brief",
|
|
"bright", "brisk", "broad", "bronze", "calm", "cerith", "cheery", "civil", "clean", "clear",
|
|
"clever", "cobalt", "cool", "copper", "coral", "cozy", "crisp", "cubic", "cyan", "deft",
|
|
"dense", "dewy", "direct", "dusky", "dusty", "early", "earnest", "earthy", "elder", "elfin",
|
|
"equal", "even", "exact", "faint", "fair", "fast", "fawn", "ferny", "fiery", "fine", "firm",
|
|
"fleet", "floral", "focal", "fond", "frank", "fresh", "frosty", "full", "gentle", "gilded",
|
|
"glacial", "glad", "glossy", "golden", "grand", "green", "gusty", "hale", "happy", "hardy",
|
|
"hazel", "hearty", "hilly", "humble", "hushed", "icy", "ideal", "inky", "iron", "ivory",
|
|
"jade", "jovial", "keen", "kind", "lapis", "leafy", "level", "light", "lilac", "limber",
|
|
"lively", "lofty", "loyal", "lucid", "lunar", "major", "maple", "marshy", "mellow", "merry",
|
|
"mild", "milky", "misty", "modest", "mossy", "muted", "narrow", "naval", "neat", "nimble",
|
|
"noble", "north", "novel", "oaken", "ochre", "olive", "onyx", "opal", "optic", "ornate",
|
|
"oval", "owed", "ozone", "pale", "pastel", "pearl", "pecan", "peppy", "pilot", "placid",
|
|
"plain", "plucky", "plum", "plush", "poised", "polar", "polished", "poplar", "prime", "proof",
|
|
"proud", "quartz", "quick", "quiet", "rainy", "rapid", "raspy", "ready", "regal", "roomy",
|
|
"rooted", "rosy", "round", "royal", "ruddy", "russet", "sage", "salty", "sandy", "satin",
|
|
"scenic", "sedge", "serene", "sheer", "silky", "silver", "sleek", "smart", "smooth", "snowy",
|
|
"snug", "solar", "solid", "south", "spry", "stark", "steady", "steel", "steep", "still",
|
|
"stocky", "stoic", "stony", "stout", "sturdy", "suede", "sunny", "supple", "sure", "tall",
|
|
"tangy", "tawny", "teal", "terse", "thick", "tidal", "tidy", "timber", "topaz", "total",
|
|
"trim", "tropic", "tulip", "upper", "urban", "vast", "velvet", "verde", "vivid", "vocal",
|
|
"warm", "waxen", "west", "whole", "wide", "wild", "wise", "witty", "woven", "young", "zealous",
|
|
"zephyr", "zesty", "zinc",
|
|
];
|
|
|
|
const NOUNS: &[&str] = &[
|
|
"acorn", "almond", "anvil", "apricot", "arbor", "atlas", "badge", "badger", "basin", "bay",
|
|
"beacon", "beam", "bell", "birch", "blade", "bloom", "bluff", "bobcat", "bolt", "breeze",
|
|
"bridge", "brook", "bunting", "burrow", "cabin", "cairn", "canyon", "cape", "cedar", "chasm",
|
|
"cliff", "clover", "coast", "cobble", "colt", "comet", "conch", "condor", "coral", "cove",
|
|
"coyote", "crane", "crater", "creek", "crest", "curlew", "daisy", "dale", "dawn", "den",
|
|
"dove", "drake", "drift", "drum", "dune", "dusk", "eagle", "eel", "egret", "elk", "emu",
|
|
"falcon", "fawn", "fennel", "fern", "ferret", "ferry", "fig", "finch", "fjord", "flicker",
|
|
"flint", "flower", "fox", "frost", "gale", "garnet", "gate", "gazelle", "geyser", "glade",
|
|
"glen", "gorge", "granite", "grove", "gull", "harbor", "hare", "haven", "hawk", "hazel",
|
|
"heath", "hedge", "heron", "hill", "hollow", "horizon", "ibis", "inlet", "isle", "ivy",
|
|
"jackal", "jasper", "juniper", "kinglet", "kitten", "knoll", "lagoon", "lake", "lantern",
|
|
"larch", "lark", "laurel", "lava", "leaf", "ledge", "lily", "linden", "lodge", "loft", "loon",
|
|
"lotus", "mantle", "maple", "marble", "marsh", "marten", "meadow", "merlin", "mill", "minnow",
|
|
"moon", "moose", "moss", "moth", "newt", "north", "nutmeg", "oak", "oasis", "obsidian",
|
|
"orbit", "orchid", "oriole", "osprey", "otter", "owl", "palm", "panther", "pass", "peach",
|
|
"peak", "pebble", "pelican", "peony", "perch", "pier", "pike", "pine", "plover", "plume",
|
|
"pond", "poppy", "prairie", "prism", "quail", "quarry", "quartz", "rain", "rampart", "raven",
|
|
"ravine", "reed", "reef", "ridge", "river", "robin", "rook", "rowan", "sage", "salmon",
|
|
"sequoia", "shore", "shrew", "shrike", "sigma", "sky", "slope", "snipe", "snow", "sparrow",
|
|
"spruce", "stag", "star", "starling", "stoat", "stone", "stork", "storm", "strand", "summit",
|
|
"sycamore", "tern", "terrace", "thistle", "thorn", "thrush", "tide", "timber", "toucan",
|
|
"trail", "trout", "tulip", "tundra", "turtle", "vale", "valley", "veranda", "violet", "viper",
|
|
"vole", "walrus", "warbler", "willow", "wolf", "wren", "yak", "zenith",
|
|
];
|
|
|
|
/// Generates a worktree name in `"adjective-noun"` format (e.g. `"calm-river"`).
|
|
///
|
|
/// Tries up to 10 random combinations, skipping any name that already appears
|
|
/// in `existing_names`. Returns `None` if no unused name is found.
|
|
pub fn generate_worktree_name(existing_names: &[&str], rng: &mut impl Rng) -> Option<String> {
|
|
let existing: HashSet<&str> = existing_names.iter().copied().collect();
|
|
|
|
for _ in 0..10 {
|
|
let adjective = ADJECTIVES[rng.random_range(0..ADJECTIVES.len())];
|
|
let noun = NOUNS[rng.random_range(0..NOUNS.len())];
|
|
let name = format!("{adjective}-{noun}");
|
|
|
|
if !existing.contains(name.as_str()) {
|
|
return Some(name);
|
|
}
|
|
}
|
|
|
|
None
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use rand::rngs::StdRng;
|
|
|
|
#[gpui::test(iterations = 10)]
|
|
fn test_generate_worktree_name_format(mut rng: StdRng) {
|
|
let name = generate_worktree_name(&[], &mut rng).unwrap();
|
|
let (adjective, noun) = name.split_once('-').expect("name should contain a hyphen");
|
|
assert!(
|
|
ADJECTIVES.contains(&adjective),
|
|
"{adjective:?} is not in ADJECTIVES"
|
|
);
|
|
assert!(NOUNS.contains(&noun), "{noun:?} is not in NOUNS");
|
|
}
|
|
|
|
#[gpui::test(iterations = 100)]
|
|
fn test_generate_worktree_name_avoids_existing(mut rng: StdRng) {
|
|
let existing = &["swift-falcon", "calm-river", "bold-cedar"];
|
|
let name = generate_worktree_name(existing, &mut rng).unwrap();
|
|
for &branch in existing {
|
|
assert_ne!(
|
|
name, branch,
|
|
"generated name should not match an existing branch"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[gpui::test]
|
|
fn test_generate_worktree_name_returns_none_when_stuck(mut rng: StdRng) {
|
|
let all_names: Vec<String> = ADJECTIVES
|
|
.iter()
|
|
.flat_map(|adj| NOUNS.iter().map(move |noun| format!("{adj}-{noun}")))
|
|
.collect();
|
|
let refs: Vec<&str> = all_names.iter().map(|s| s.as_str()).collect();
|
|
let result = generate_worktree_name(&refs, &mut rng);
|
|
assert!(result.is_none());
|
|
}
|
|
|
|
#[test]
|
|
fn test_adjectives_are_valid() {
|
|
let mut seen = HashSet::default();
|
|
for &word in ADJECTIVES {
|
|
assert!(seen.insert(word), "duplicate entry in ADJECTIVES: {word:?}");
|
|
}
|
|
|
|
for window in ADJECTIVES.windows(2) {
|
|
assert!(
|
|
window[0] < window[1],
|
|
"ADJECTIVES is not sorted: {0:?} should come before {1:?}",
|
|
window[0],
|
|
window[1],
|
|
);
|
|
}
|
|
|
|
for &word in ADJECTIVES {
|
|
assert!(
|
|
!word.contains('-'),
|
|
"ADJECTIVES entry contains a hyphen: {word:?}"
|
|
);
|
|
assert!(
|
|
word.chars().all(|c| c.is_lowercase()),
|
|
"ADJECTIVES entry is not all lowercase: {word:?}"
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_nouns_are_valid() {
|
|
let mut seen = HashSet::default();
|
|
for &word in NOUNS {
|
|
assert!(seen.insert(word), "duplicate entry in NOUNS: {word:?}");
|
|
}
|
|
|
|
for window in NOUNS.windows(2) {
|
|
assert!(
|
|
window[0] < window[1],
|
|
"NOUNS is not sorted: {0:?} should come before {1:?}",
|
|
window[0],
|
|
window[1],
|
|
);
|
|
}
|
|
|
|
for &word in NOUNS {
|
|
assert!(
|
|
!word.contains('-'),
|
|
"NOUNS entry contains a hyphen: {word:?}"
|
|
);
|
|
assert!(
|
|
word.chars().all(|c| c.is_lowercase()),
|
|
"NOUNS entry is not all lowercase: {word:?}"
|
|
);
|
|
}
|
|
}
|
|
}
|