Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b7781a830c | ||
|
|
3abe8755c8 | ||
|
|
b6d0b55d4b | ||
|
|
3fcb0ddc0a | ||
|
|
8563218ab5 | ||
|
|
54569b2c85 |
@@ -33,7 +33,7 @@
|
||||
|
||||
### Color and Output
|
||||
- Use `color_text()` helper for colored output — it respects `should_use_colors()` (terminal detection)
|
||||
- Color codes are defined in `get_color()`: red (31), cyan (36), orange (33), green (32), grey (90)
|
||||
- Color codes are defined in `get_color()`: red (31), cyan (36), orange (33), green (32), grey (38;5;8), magenta (1;35)
|
||||
- Reset color with `\x1b[0m` after colored text
|
||||
- Bold uses `\x1b[1;35m` (magenta bold)
|
||||
- Always test color output works correctly in both terminal and pipe modes
|
||||
@@ -43,7 +43,8 @@
|
||||
- Status → orange (33)
|
||||
- Timestamp → cyan (36)
|
||||
- Title → green (32)
|
||||
- Unknown values (`_None_`, `_Not set_`) → grey (90)
|
||||
- Unknown values (`_None_`, `_Not set_`) → grey (38;5;8)
|
||||
- Grey is indexed colour 8 in the 256-colour form, not SGR 90 or 37. Both of those failed on a real palette: 90 leans on the bright-black slot and 37 can sit on top of the default foreground. `\x1b[38;5;8m` is byte for byte what crossterm emits for ratatui's `Color::DarkGray`, the grey frig and pantop use for dimmed rows
|
||||
|
||||
### Code Organization
|
||||
- Colorization functions (`colorize_line`, `colorize_metadata`, `colorize_ordered`, `content_trim_colored`) handle markdown formatting
|
||||
@@ -60,3 +61,14 @@
|
||||
- Commit format: `([ticketID]) [short description]`
|
||||
- Use `--fixup` for incremental changes
|
||||
- Test before moving to reviewing status
|
||||
|
||||
### Version Bumps
|
||||
- Before every commit, decide whether the change warrants a version bump in `Cargo.toml`
|
||||
- Always ask the user to confirm the bump and its kind before making it — never bump silently, and never skip the question because the answer looks obvious
|
||||
- Pre-1.0, so: patch for fixes and internal changes, minor for a new command, flag or changed output, major only for a deliberate 1.0
|
||||
- No bump for docs-only, tests-only or `--fixup` commits
|
||||
- When one body of work spans several commits, bump once on the final commit rather than on each
|
||||
- Bump `Cargo.toml` and the `worklane` entry in `Cargo.lock` together, in the commit that carries the bump
|
||||
- Every bump gets a matching annotated tag, `v<version>`, on the bump commit — a bumped version is never left untagged
|
||||
- Tag locally only; never push a tag unless asked
|
||||
- `worklane --version` reports the crate version alongside the build sha, so the bump is what makes one release distinguishable from another
|
||||
|
||||
Generated
+1
-1
@@ -1029,7 +1029,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "worklane"
|
||||
version = "0.1.0"
|
||||
version = "0.1.2"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"assert_cmd",
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "worklane"
|
||||
version = "0.1.0"
|
||||
version = "0.1.2"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
|
||||
+70
-4
@@ -1,6 +1,7 @@
|
||||
use anyhow::{Result, anyhow};
|
||||
use chrono::Local;
|
||||
use std::fs;
|
||||
use std::io::Write;
|
||||
use std::path::Path;
|
||||
|
||||
use crate::util::*;
|
||||
@@ -234,6 +235,40 @@ fn read_comments(comments_dir: &Path) -> Result<Vec<(String, String, String, Str
|
||||
Ok(comments)
|
||||
}
|
||||
|
||||
/// Write a comment under the first free name derived from `stem`.
|
||||
///
|
||||
/// `create_new` rather than `fs::write`: a name that already exists means another
|
||||
/// comment landed in the same microsecond, and truncating it is exactly the data
|
||||
/// loss this guards against. The suffix is zero padded so the names keep sorting
|
||||
/// in the order they were written.
|
||||
fn write_new_comment(comments_dir: &Path, stem: &str, content: &str) -> Result<String> {
|
||||
for attempt in 0..100 {
|
||||
let filename = match attempt {
|
||||
0 => format!("{}.md", stem),
|
||||
n => format!("{}_{:02}.md", stem, n),
|
||||
};
|
||||
|
||||
match fs::OpenOptions::new()
|
||||
.write(true)
|
||||
.create_new(true)
|
||||
.open(comments_dir.join(&filename))
|
||||
{
|
||||
Ok(mut file) => {
|
||||
file.write_all(content.as_bytes())?;
|
||||
return Ok(filename);
|
||||
}
|
||||
Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => continue,
|
||||
Err(e) => return Err(e.into()),
|
||||
}
|
||||
}
|
||||
|
||||
Err(anyhow!(
|
||||
"No free comment filename for '{}' in {}",
|
||||
stem,
|
||||
comments_dir.display()
|
||||
))
|
||||
}
|
||||
|
||||
pub fn cmd_show(search: &str, worklane_dir: &Path) -> Result<()> {
|
||||
let (_status, title, content) = resolve_ticket(search, worklane_dir)?;
|
||||
let ticket_uuid = parse_ticket_field(&content, "ID");
|
||||
@@ -351,6 +386,39 @@ pub fn cmd_mv(ticket_id: &str, target_status: &str, force: bool, start: &Path) -
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
/// The collision path cannot be provoked from the CLI, since two processes
|
||||
/// will not share a microsecond, but it is the whole point of the guard.
|
||||
#[test]
|
||||
fn a_colliding_stem_takes_the_next_name_and_keeps_the_first() {
|
||||
let dir = std::env::temp_dir().join(format!("worklane-test-{}", uuid::Uuid::new_v4()));
|
||||
fs::create_dir_all(&dir).unwrap();
|
||||
|
||||
let first = write_new_comment(&dir, "20260820_143012_123456", "first").unwrap();
|
||||
let second = write_new_comment(&dir, "20260820_143012_123456", "second").unwrap();
|
||||
let third = write_new_comment(&dir, "20260820_143012_123456", "third").unwrap();
|
||||
|
||||
assert_eq!(first, "20260820_143012_123456.md");
|
||||
assert_eq!(second, "20260820_143012_123456_01.md");
|
||||
assert_eq!(third, "20260820_143012_123456_02.md");
|
||||
|
||||
// Nothing was truncated on the way through
|
||||
assert_eq!(fs::read_to_string(dir.join(&first)).unwrap(), "first");
|
||||
assert_eq!(fs::read_to_string(dir.join(&second)).unwrap(), "second");
|
||||
assert_eq!(fs::read_to_string(dir.join(&third)).unwrap(), "third");
|
||||
|
||||
// read_comments sorts on the stem, so the names must sort in write order
|
||||
let mut names = vec![second.clone(), third.clone(), first.clone()];
|
||||
names.sort();
|
||||
assert_eq!(names, vec![first, second, third]);
|
||||
|
||||
fs::remove_dir_all(&dir).unwrap();
|
||||
}
|
||||
}
|
||||
|
||||
pub fn cmd_comment(
|
||||
ticket_id: &str,
|
||||
body: &str,
|
||||
@@ -372,9 +440,7 @@ pub fn cmd_comment(
|
||||
let comments_dir = worklane_dir.join("comments").join(&ticket_uuid);
|
||||
fs::create_dir_all(&comments_dir)?;
|
||||
|
||||
let timestamp = Local::now().format("%Y%m%d_%H%M%S");
|
||||
let filename = format!("{}.md", timestamp);
|
||||
let filepath = comments_dir.join(&filename);
|
||||
let stem = Local::now().format(COMMENT_FILE_FORMAT).to_string();
|
||||
|
||||
let author = match owner {
|
||||
Some(o) => o.clone(),
|
||||
@@ -393,7 +459,7 @@ pub fn cmd_comment(
|
||||
Local::now().format(TIMESTAMP_FORMAT)
|
||||
);
|
||||
|
||||
fs::write(&filepath, comment_content)?;
|
||||
let filename = write_new_comment(&comments_dir, &stem, &comment_content)?;
|
||||
|
||||
println!("Comment added to '{}' ({})", title, filename);
|
||||
Ok(())
|
||||
|
||||
+189
-22
@@ -3,13 +3,53 @@ use chrono::NaiveDateTime;
|
||||
use std::fs;
|
||||
use std::io::IsTerminal;
|
||||
use std::path::Path;
|
||||
use std::sync::OnceLock;
|
||||
|
||||
/// How timestamps are written into tickets and comments, and therefore how they
|
||||
/// are read back. Shared so the writer and the reader cannot drift apart.
|
||||
pub const TIMESTAMP_FORMAT: &str = "%Y-%m-%d %H:%M:%S";
|
||||
|
||||
/// How a comment filename is stamped.
|
||||
///
|
||||
/// Microseconds, not seconds: at second resolution two comments in the same
|
||||
/// second produced the same name and the second silently truncated the first.
|
||||
/// Fixed width, so the lexicographic sort in `read_comments` stays chronological.
|
||||
pub const COMMENT_FILE_FORMAT: &str = "%Y%m%d_%H%M%S_%6f";
|
||||
|
||||
/// Whether colour is wanted, from the three inputs that decide it.
|
||||
///
|
||||
/// Split out from the caching wrapper so it can be tested without a pty and
|
||||
/// without touching the process environment.
|
||||
///
|
||||
/// `NO_COLOR` follows the no-color.org convention: set and non-empty disables,
|
||||
/// whatever the value. An empty value is treated as unset, which is what lets a
|
||||
/// wrapper script clear an inherited one.
|
||||
fn colors_wanted(is_terminal: bool, no_color: Option<&str>, term: Option<&str>) -> bool {
|
||||
if no_color.is_some_and(|value| !value.is_empty()) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if matches!(term, Some("dumb") | Some("")) {
|
||||
return false;
|
||||
}
|
||||
|
||||
is_terminal
|
||||
}
|
||||
|
||||
pub fn should_use_colors() -> bool {
|
||||
std::io::stdout().is_terminal()
|
||||
// Decided once: it cannot change mid-run, and color_text asks on every call.
|
||||
static ENABLED: OnceLock<bool> = OnceLock::new();
|
||||
|
||||
*ENABLED.get_or_init(|| {
|
||||
let no_color = std::env::var("NO_COLOR").ok();
|
||||
let term = std::env::var("TERM").ok();
|
||||
|
||||
colors_wanted(
|
||||
std::io::stdout().is_terminal(),
|
||||
no_color.as_deref(),
|
||||
term.as_deref(),
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
pub fn get_color(color: &str) -> &'static str {
|
||||
@@ -18,7 +58,15 @@ pub fn get_color(color: &str) -> &'static str {
|
||||
"cyan" => "\x1b[36m",
|
||||
"orange" => "\x1b[33m",
|
||||
"green" => "\x1b[32m",
|
||||
"grey" => "\x1b[90m",
|
||||
// Indexed colour 8 in the 256-colour form, which is byte for byte what
|
||||
// crossterm emits for ratatui's Color::DarkGray, the grey frig and pantop
|
||||
// use for dimmed rows. Neither SGR 90 nor 37 renders as grey on every
|
||||
// palette: 90 leans on the bright-black slot and 37 can sit right on top
|
||||
// of the default foreground.
|
||||
"grey" => "\x1b[38;5;8m",
|
||||
// Bold, per the guideline in AGENTS.md. Its absence meant colorize_line
|
||||
// asked for a colour that did not exist and got an empty prefix.
|
||||
"magenta" => "\x1b[1;35m",
|
||||
_ => "",
|
||||
}
|
||||
}
|
||||
@@ -339,37 +387,53 @@ pub fn is_unknown_value(value: &str) -> bool {
|
||||
}
|
||||
|
||||
pub fn colorize_line(line: &str) -> String {
|
||||
let mut result = String::new();
|
||||
colorize_bold(line, should_use_colors())
|
||||
}
|
||||
|
||||
/// Replace `**bold**` with colour, or leave the line exactly as it is.
|
||||
///
|
||||
/// Taking `enabled` rather than asking makes both paths testable, and the
|
||||
/// disabled path matters: stripping the markers when there is no colour to
|
||||
/// replace them with loses the emphasis altogether, which is what happens to
|
||||
/// every piped `show` and to everything the opencode tools read.
|
||||
fn colorize_bold(line: &str, enabled: bool) -> String {
|
||||
if !enabled {
|
||||
return line.to_string();
|
||||
}
|
||||
|
||||
let chars: Vec<char> = line.chars().collect();
|
||||
let len = chars.len();
|
||||
let mut result = String::new();
|
||||
let mut i = 0;
|
||||
|
||||
while i < len {
|
||||
// Check for **bold** markdown
|
||||
if i + 1 < len && chars[i] == '*' && chars[i + 1] == '*' {
|
||||
// Find closing **
|
||||
let start = i + 2;
|
||||
let mut end = start;
|
||||
while end + 1 < len && !(chars[end] == '*' && chars[end + 1] == '*') {
|
||||
if chars[end] == '\n' {
|
||||
break;
|
||||
}
|
||||
end += 1;
|
||||
}
|
||||
|
||||
let bold_text: String = chars[start..end].iter().collect();
|
||||
result.push_str(&color_text(&bold_text, "magenta"));
|
||||
i = end + 2;
|
||||
while i < chars.len() {
|
||||
if !is_delimiter(&chars, i) {
|
||||
result.push(chars[i]);
|
||||
i += 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
result.push(chars[i]);
|
||||
i += 1;
|
||||
match (i + 2..chars.len()).find(|&at| is_delimiter(&chars, at)) {
|
||||
Some(close) => {
|
||||
let bold: String = chars[i + 2..close].iter().collect();
|
||||
result.push_str(&color_text(&bold, "magenta"));
|
||||
i = close + 2;
|
||||
}
|
||||
// Unterminated: the rest is literal. The old scan walked off the end
|
||||
// here and dropped the final character.
|
||||
None => {
|
||||
result.extend(&chars[i..]);
|
||||
return result;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
result
|
||||
}
|
||||
|
||||
fn is_delimiter(chars: &[char], at: usize) -> bool {
|
||||
chars.get(at) == Some(&'*') && chars.get(at + 1) == Some(&'*')
|
||||
}
|
||||
|
||||
pub fn parse_ticket_field(content: &str, field: &str) -> String {
|
||||
let pattern = format!("**{}**:", field);
|
||||
content
|
||||
@@ -434,9 +498,24 @@ pub fn status_dirs() -> Vec<&'static str> {
|
||||
|
||||
pub type TicketItem = (String, String, String, String, String);
|
||||
|
||||
/// Grey for a value that is not set, per the colour guideline.
|
||||
///
|
||||
/// `show` already did this through `colorize_metadata`, so the listing was the
|
||||
/// one place that ignored the rule.
|
||||
fn dim_if_unset(value: &str) -> String {
|
||||
if is_unknown_value(value) {
|
||||
color_text(value, "grey")
|
||||
} else {
|
||||
value.to_string()
|
||||
}
|
||||
}
|
||||
|
||||
pub fn display_ticket_items(items: &Vec<TicketItem>) {
|
||||
for (title, owner, due, uuid, ts) in items {
|
||||
let uuid_colored = color_text(uuid, "red");
|
||||
let owner = dim_if_unset(owner);
|
||||
let due = dim_if_unset(due);
|
||||
|
||||
if ts.is_empty() {
|
||||
println!(
|
||||
" ({}) {} | Owner: {} | Due: {}",
|
||||
@@ -488,6 +567,94 @@ pub fn collect_ticket_items(status_path: impl AsRef<Path>) -> Result<Vec<TicketI
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn no_color_disables_colour_on_a_terminal() {
|
||||
assert!(!colors_wanted(true, Some("1"), Some("xterm-256color")));
|
||||
// Any value at all, per the convention
|
||||
assert!(!colors_wanted(true, Some("0"), Some("xterm-256color")));
|
||||
assert!(!colors_wanted(true, Some("false"), Some("xterm-256color")));
|
||||
}
|
||||
|
||||
/// An empty value counts as unset, so a wrapper script can clear one it
|
||||
/// inherited.
|
||||
#[test]
|
||||
fn an_empty_no_color_is_ignored() {
|
||||
assert!(colors_wanted(true, Some(""), Some("xterm-256color")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_dumb_terminal_gets_no_colour() {
|
||||
assert!(!colors_wanted(true, None, Some("dumb")));
|
||||
assert!(!colors_wanted(true, None, Some("")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn colour_needs_a_terminal() {
|
||||
assert!(colors_wanted(true, None, Some("xterm-256color")));
|
||||
assert!(!colors_wanted(false, None, Some("xterm-256color")));
|
||||
// No TERM at all is fine as long as it is a terminal
|
||||
assert!(colors_wanted(true, None, None));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn unset_values_are_dimmed_and_set_ones_are_not() {
|
||||
// Colour is off in a test process, so this asserts the decision, not the escape
|
||||
for unset in ["_Not set_", "_None_"] {
|
||||
assert!(is_unknown_value(unset), "{unset} should count as unset");
|
||||
assert_eq!(dim_if_unset(unset), unset);
|
||||
}
|
||||
|
||||
for set in ["alice", "2026-12-31", "bug,frontend"] {
|
||||
assert!(!is_unknown_value(set));
|
||||
assert_eq!(dim_if_unset(set), set);
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn every_colour_the_code_asks_for_exists() {
|
||||
for colour in ["red", "cyan", "orange", "green", "grey", "magenta"] {
|
||||
assert!(!get_color(colour).is_empty(), "{colour} is not defined");
|
||||
}
|
||||
}
|
||||
|
||||
/// Pinned deliberately. Both SGR spellings of grey failed on a real palette,
|
||||
/// 90 reading nearly as light as the foreground and 37 sitting on top of it.
|
||||
/// This is the exact sequence crossterm emits for ratatui's Color::DarkGray,
|
||||
/// so worklane's grey is the one frig and pantop already render.
|
||||
#[test]
|
||||
fn grey_matches_the_indexed_colour_frig_uses() {
|
||||
assert_eq!(get_color("grey"), "\x1b[38;5;8m");
|
||||
}
|
||||
|
||||
/// With no colour to carry the emphasis, the markers are the emphasis.
|
||||
#[test]
|
||||
fn bold_markers_survive_when_colour_is_off() {
|
||||
let line = "Some **bold** text";
|
||||
assert_eq!(colorize_bold(line, false), line);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn bold_markers_are_replaced_when_colour_is_on() {
|
||||
let out = colorize_bold("Some **bold** text", true);
|
||||
assert!(out.contains("bold"), "was {out:?}");
|
||||
assert!(!out.contains("**"), "markers left behind in {out:?}");
|
||||
}
|
||||
|
||||
/// The old scan ran past the end here and dropped the last character.
|
||||
#[test]
|
||||
fn an_unterminated_marker_keeps_the_whole_line() {
|
||||
for line in ["a **bold", "**", "***", "trailing **"] {
|
||||
assert_eq!(colorize_bold(line, true), line, "for {line:?}");
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn several_bold_runs_on_one_line_all_survive() {
|
||||
let out = colorize_bold("**one** and **two** and rest", true);
|
||||
assert!(out.contains("one") && out.contains("two") && out.ends_with("and rest"));
|
||||
assert!(!out.contains("**"), "was {out:?}");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn short_id_shortens_a_full_uuid() {
|
||||
assert_eq!(short_id("c230d2c6-d78a-44a5-8f5f-88fb28f84493"), "c230d2c");
|
||||
|
||||
@@ -212,3 +212,41 @@ fn comment_falls_back_to_git_user_when_owner_omitted() {
|
||||
let content = fs::read_to_string(files[0].path()).unwrap();
|
||||
assert!(content.contains("**Author**"));
|
||||
}
|
||||
|
||||
/// Second-resolution filenames meant the second of two quick comments
|
||||
/// truncated the first.
|
||||
#[test]
|
||||
fn comments_added_back_to_back_are_both_kept() {
|
||||
let temp = TempDir::new().unwrap();
|
||||
let worklane = setup_worklane(&temp);
|
||||
|
||||
let uuid = create_ticket(&worklane, "backlog", "Rapid Fire");
|
||||
|
||||
for body in ["first comment", "second comment", "third comment"] {
|
||||
Command::cargo_bin(BIN_NAME)
|
||||
.unwrap()
|
||||
.current_dir(&temp.path())
|
||||
.arg("comment")
|
||||
.args([&uuid, body])
|
||||
.assert()
|
||||
.success();
|
||||
}
|
||||
|
||||
let comments_dir = worklane.join("comments").join(&uuid);
|
||||
let files: Vec<_> = fs::read_dir(&comments_dir)
|
||||
.unwrap()
|
||||
.filter_map(|e| e.ok())
|
||||
.collect();
|
||||
assert_eq!(files.len(), 3, "a comment was overwritten");
|
||||
|
||||
// And show has to render them in the order they were added
|
||||
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
|
||||
cmd.current_dir(&temp.path()).arg("show").arg(&uuid);
|
||||
let assert = cmd.assert().success();
|
||||
let stdout = String::from_utf8(assert.get_output().stdout.clone()).unwrap();
|
||||
|
||||
let first = stdout.find("first comment").expect("first comment missing");
|
||||
let second = stdout.find("second comment").expect("second comment missing");
|
||||
let third = stdout.find("third comment").expect("third comment missing");
|
||||
assert!(first < second && second < third, "comments out of order");
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user