Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f557437f62 | ||
|
|
75fb2b3a6d | ||
|
|
8b440593e2 | ||
|
|
ab1dae098c |
@@ -48,9 +48,13 @@
|
|||||||
- 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
|
- 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
|
### Code Organization
|
||||||
- Colorization functions (`colorize_line`, `colorize_metadata`, `colorize_ordered`, `content_trim_colored`) handle markdown formatting
|
- Colorization functions (`colorize_line`, `colorize_ordered`, `content_trim_colored`) handle markdown formatting
|
||||||
|
- `show` renders the Metadata section as a two column table via `render_metadata_table`, not line by line. Column width is measured on the raw field names in characters and padding is applied before anything is styled: measuring a coloured string counts its escapes towards its width. `paint()` is `color_text()` with the colour decision passed in, which is what lets a test render both ways in one process
|
||||||
|
- The title is printed once, by `cmd_show`. `content_trim_colored` skips the `# ` heading in the file content
|
||||||
|
- Rules under headings are measured on the displayed name in characters, never on the raw line or in bytes
|
||||||
- `resolve_ticket()` scans all status directories — it's the single source for ticket lookup by UUID prefix, title, or filename
|
- `resolve_ticket()` scans all status directories — it's the single source for ticket lookup by UUID prefix, title, or filename
|
||||||
- `parse_ticket_field()` handles extracting metadata values from markdown format
|
- `parse_ticket_field()` handles extracting metadata values from markdown format
|
||||||
|
- Field lookup, read and write, is scoped to the lines under the `## Metadata` heading and anchored to the start of the line. Prose above it is free text: tickets in this repo quote field markers in their descriptions, and an unscoped search reads or rewrites those instead. `set_status_field()` carries the same scoping
|
||||||
|
|
||||||
### Ticket Resolution
|
### Ticket Resolution
|
||||||
- `resolve_ticket()` returns `(status, title, content)` tuple
|
- `resolve_ticket()` returns `(status, title, content)` tuple
|
||||||
|
|||||||
Generated
+1
-1
@@ -1029,7 +1029,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "worklane"
|
name = "worklane"
|
||||||
version = "0.2.0"
|
version = "0.3.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"anyhow",
|
"anyhow",
|
||||||
"assert_cmd",
|
"assert_cmd",
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
[package]
|
[package]
|
||||||
name = "worklane"
|
name = "worklane"
|
||||||
version = "0.2.0"
|
version = "0.3.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
|||||||
+5
-2
@@ -294,8 +294,11 @@ pub fn cmd_show(search: &str, worklane_dir: &Path) -> Result<()> {
|
|||||||
let (_status, title, content) = resolve_ticket(search, worklane_dir)?;
|
let (_status, title, content) = resolve_ticket(search, worklane_dir)?;
|
||||||
let ticket_uuid = parse_ticket_field(&content, "ID");
|
let ticket_uuid = parse_ticket_field(&content, "ID");
|
||||||
|
|
||||||
println!("{}", title);
|
// The only title in the output: content_trim_colored used to print it a second
|
||||||
println!("{}", "─".repeat(title.len()));
|
// time from the file content. Green per the colour guideline, and the rule is
|
||||||
|
// measured in characters so a non-ASCII title is not over-drawn.
|
||||||
|
println!("{}", color_text(&title, "green"));
|
||||||
|
println!("{}", "─".repeat(title.chars().count()));
|
||||||
println!("\n{}", content_trim_colored(&content));
|
println!("\n{}", content_trim_colored(&content));
|
||||||
|
|
||||||
if ticket_uuid != "_Not set_" {
|
if ticket_uuid != "_Not set_" {
|
||||||
|
|||||||
+445
-91
@@ -73,14 +73,22 @@ pub fn get_color(color: &str) -> &'static str {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn color_text(text: &str, color: &str) -> String {
|
/// `color_text` with the decision passed in rather than asked for.
|
||||||
if should_use_colors() {
|
///
|
||||||
|
/// The seam matters for anything that aligns columns: a caller has to be able to
|
||||||
|
/// render both ways in one process to prove the padding does not depend on it.
|
||||||
|
pub fn paint(text: &str, color: &str, enabled: bool) -> String {
|
||||||
|
if enabled {
|
||||||
format!("{}{}{}", get_color(color), text, "\x1b[0m")
|
format!("{}{}{}", get_color(color), text, "\x1b[0m")
|
||||||
} else {
|
} else {
|
||||||
text.to_string()
|
text.to_string()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn color_text(text: &str, color: &str) -> String {
|
||||||
|
paint(text, color, should_use_colors())
|
||||||
|
}
|
||||||
|
|
||||||
pub fn find_worklane_dir(start: &Path) -> Result<std::path::PathBuf> {
|
pub fn find_worklane_dir(start: &Path) -> Result<std::path::PathBuf> {
|
||||||
let mut current = start.canonicalize()?;
|
let mut current = start.canonicalize()?;
|
||||||
|
|
||||||
@@ -251,30 +259,54 @@ pub fn format_comments(comments: &[(String, String, String, String)]) -> String
|
|||||||
}
|
}
|
||||||
pub fn content_trim_colored(content: &str) -> String {
|
pub fn content_trim_colored(content: &str) -> String {
|
||||||
let lines: Vec<&str> = content.trim().lines().collect();
|
let lines: Vec<&str> = content.trim().lines().collect();
|
||||||
|
let colored = should_use_colors();
|
||||||
let mut result = String::new();
|
let mut result = String::new();
|
||||||
let mut current_section = "";
|
let mut current_section = "";
|
||||||
|
let mut i = 0;
|
||||||
|
|
||||||
|
while i < lines.len() {
|
||||||
|
let line = lines[i];
|
||||||
|
|
||||||
for line in &lines {
|
|
||||||
// Track current section
|
// Track current section
|
||||||
if line.starts_with("## ") {
|
if let Some(section_name) = line.strip_prefix("## ") {
|
||||||
current_section = line;
|
current_section = line;
|
||||||
let section_name = &line[3..];
|
result.push_str(&paint(section_name, "orange", colored));
|
||||||
result.push_str(&color_text(section_name, "orange"));
|
|
||||||
result.push('\n');
|
result.push('\n');
|
||||||
result.push_str(&"─".repeat(line.len()));
|
// Measured on the name as displayed, in characters. The rule used to span
|
||||||
|
// the raw line, so it ran three past the heading for the "## ", and byte
|
||||||
|
// length over-drew for anything non-ASCII.
|
||||||
|
result.push_str(&"─".repeat(section_name.chars().count()));
|
||||||
result.push('\n');
|
result.push('\n');
|
||||||
result.push('\n');
|
result.push('\n');
|
||||||
|
i += 1;
|
||||||
|
|
||||||
|
// Metadata is rendered as a block, so it is consumed here rather than
|
||||||
|
// falling through to the line-at-a-time cases below.
|
||||||
|
if is_metadata_heading(line) {
|
||||||
|
let end = lines[i..]
|
||||||
|
.iter()
|
||||||
|
.position(|l| l.starts_with("## "))
|
||||||
|
.map_or(lines.len(), |offset| i + offset);
|
||||||
|
result.push_str(&render_metadata_table(&lines[i..end], colored));
|
||||||
|
i = end;
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
// First line is the title header - color it in green
|
// The title belongs to cmd_show, which prints it with its rule. Printing it
|
||||||
|
// again from the file content is what repeated it in every show output.
|
||||||
if line.starts_with("# ") && current_section.is_empty() {
|
if line.starts_with("# ") && current_section.is_empty() {
|
||||||
let header = &line[2..]; // Remove "# "
|
i += 1;
|
||||||
result.push_str(&color_text(header, "green"));
|
// Along with the blank line the template puts under it, so dropping the
|
||||||
result.push('\n');
|
// title does not leave a gap where it used to be.
|
||||||
|
while i < lines.len() && lines[i].trim().is_empty() {
|
||||||
|
i += 1;
|
||||||
|
}
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
i += 1;
|
||||||
|
|
||||||
// Implementation Plan - color numbers in cyan
|
// Implementation Plan - color numbers in cyan
|
||||||
if current_section == "## Implementation Plan" {
|
if current_section == "## Implementation Plan" {
|
||||||
result.push_str(&colorize_ordered(line));
|
result.push_str(&colorize_ordered(line));
|
||||||
@@ -282,16 +314,9 @@ pub fn content_trim_colored(content: &str) -> String {
|
|||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Metadata - color field names in RED
|
|
||||||
if current_section == "## Metadata" {
|
|
||||||
result.push_str(&colorize_metadata(line));
|
|
||||||
result.push('\n');
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Acceptance Criteria checkboxes
|
// Acceptance Criteria checkboxes
|
||||||
if line.starts_with("- [ ]") {
|
if line.starts_with("- [ ]") {
|
||||||
result.push_str(&color_text("- [ ]", "grey"));
|
result.push_str(&paint("- [ ]", "grey", colored));
|
||||||
result.push_str(&line[5..]);
|
result.push_str(&line[5..]);
|
||||||
result.push('\n');
|
result.push('\n');
|
||||||
continue;
|
continue;
|
||||||
@@ -346,56 +371,91 @@ pub fn colorize_ordered(line: &str) -> String {
|
|||||||
line.to_string()
|
line.to_string()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn colorize_metadata(line: &str) -> String {
|
/// Space between the field column and the value column.
|
||||||
if !line.contains("**") {
|
const METADATA_GUTTER: &str = " ";
|
||||||
return line.to_string();
|
|
||||||
|
/// One line of the Metadata section, as the table sees it.
|
||||||
|
enum MetadataRow<'a> {
|
||||||
|
/// A `- **Name**: value` line, the shape the file stores fields in.
|
||||||
|
Field { name: &'a str, value: &'a str },
|
||||||
|
/// Anything else, carried through verbatim so a hand-written note in the
|
||||||
|
/// section is not dropped on the way to the screen.
|
||||||
|
Other(&'a str),
|
||||||
}
|
}
|
||||||
|
|
||||||
// Priority reads as a glyph here too, while the file keeps storing the number.
|
/// Split a metadata line into a field and its value, sharing the anchoring rules
|
||||||
if let Some(value) = line.split("**Priority**:").nth(1) {
|
/// `parse_ticket_field` uses: list marker optional, name matched at the start.
|
||||||
let priority = match value.trim().parse::<u8>() {
|
fn metadata_row(line: &str) -> MetadataRow<'_> {
|
||||||
Ok(level) if PRIORITY_RANGE.contains(&level) => Priority::Level(level),
|
let body = metadata_field_body(line);
|
||||||
_ if is_unknown_value(value.trim()) => Priority::Unset,
|
let Some(rest) = body.strip_prefix("**") else {
|
||||||
_ => Priority::Invalid,
|
return MetadataRow::Other(line);
|
||||||
};
|
};
|
||||||
return format!(
|
let Some(close) = rest.find("**:") else {
|
||||||
"- {}: {} {}",
|
return MetadataRow::Other(line);
|
||||||
color_text("Priority", "red"),
|
};
|
||||||
show_priority(priority),
|
|
||||||
value.trim()
|
MetadataRow::Field {
|
||||||
);
|
name: &rest[..close],
|
||||||
|
value: rest[close + "**:".len()..].trim(),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
let content = line;
|
/// The value cell for a field, styled per the colour guideline.
|
||||||
let open_pos = match content.find("**") {
|
fn metadata_value_cell(name: &str, value: &str, colored: bool) -> String {
|
||||||
Some(p) => p,
|
if name == "Priority" {
|
||||||
None => return content.to_string(),
|
// Reads as a glyph, while the file keeps storing the number.
|
||||||
};
|
let (glyph, colour) = priority_mark(priority_from_value(value));
|
||||||
|
return format!("{} {}", paint(glyph, colour, colored), value);
|
||||||
|
}
|
||||||
|
|
||||||
let after_open = open_pos + 2;
|
if is_unknown_value(value) {
|
||||||
let remaining = &content[after_open..];
|
return paint(value, "grey", colored);
|
||||||
let close_pos = match remaining.find("**") {
|
}
|
||||||
Some(p) => p,
|
|
||||||
None => return content.to_string(),
|
|
||||||
};
|
|
||||||
|
|
||||||
let field_name = &content[after_open..after_open + close_pos];
|
value.to_string()
|
||||||
let after_field = &content[after_open + close_pos + 2..];
|
}
|
||||||
|
|
||||||
let colored_field = color_text(field_name, "red");
|
/// Render the Metadata section as two aligned columns.
|
||||||
let value_text = after_field.strip_prefix(": ").map(|s| s.trim()).unwrap_or(after_field);
|
///
|
||||||
let after_field_colored = if is_unknown_value(value_text) {
|
/// Taken as a block rather than a line at a time because the field column cannot be
|
||||||
color_text(after_field, "grey")
|
/// sized until every name has been seen. The file is untouched by this: it goes on
|
||||||
} else {
|
/// storing the markdown list, and this is only how the list is shown.
|
||||||
after_field.to_string()
|
fn render_metadata_table(lines: &[&str], colored: bool) -> String {
|
||||||
};
|
// The heading already emits its own blank separator, so the one the template
|
||||||
|
// puts under it would otherwise open the section with a gap.
|
||||||
|
let start = lines
|
||||||
|
.iter()
|
||||||
|
.position(|line| !line.trim().is_empty())
|
||||||
|
.unwrap_or(lines.len());
|
||||||
|
let rows: Vec<MetadataRow> = lines[start..].iter().map(|line| metadata_row(line)).collect();
|
||||||
|
|
||||||
format!(
|
// Measured on the raw names, in characters, and padded before anything is
|
||||||
"{}{}{}",
|
// styled. Measuring a coloured name counts its escape sequences towards its
|
||||||
&content[..open_pos],
|
// width, which is what tilts a table when colour is on and not when it is off.
|
||||||
colored_field,
|
let field_width = rows
|
||||||
after_field_colored
|
.iter()
|
||||||
)
|
.filter_map(|row| match row {
|
||||||
|
MetadataRow::Field { name, .. } => Some(name.chars().count()),
|
||||||
|
MetadataRow::Other(_) => None,
|
||||||
|
})
|
||||||
|
.max()
|
||||||
|
.unwrap_or(0);
|
||||||
|
|
||||||
|
let mut result = String::new();
|
||||||
|
for row in &rows {
|
||||||
|
match row {
|
||||||
|
MetadataRow::Field { name, value } => {
|
||||||
|
result.push_str(&paint(name, "red", colored));
|
||||||
|
result.push_str(&" ".repeat(field_width - name.chars().count()));
|
||||||
|
result.push_str(METADATA_GUTTER);
|
||||||
|
result.push_str(&metadata_value_cell(name, value, colored));
|
||||||
|
}
|
||||||
|
MetadataRow::Other(text) => result.push_str(&colorize_line(text)),
|
||||||
|
}
|
||||||
|
result.push('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
result
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn is_unknown_value(value: &str) -> bool {
|
pub fn is_unknown_value(value: &str) -> bool {
|
||||||
@@ -451,33 +511,61 @@ fn is_delimiter(chars: &[char], at: usize) -> bool {
|
|||||||
chars.get(at) == Some(&'*') && chars.get(at + 1) == Some(&'*')
|
chars.get(at) == Some(&'*') && chars.get(at + 1) == Some(&'*')
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn parse_ticket_field(content: &str, field: &str) -> String {
|
const METADATA_HEADING: &str = "## Metadata";
|
||||||
let pattern = format!("**{}**:", field);
|
|
||||||
|
fn is_metadata_heading(line: &str) -> bool {
|
||||||
|
line.trim_end() == METADATA_HEADING
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The lines of the Metadata section, or nothing when the heading is absent.
|
||||||
|
///
|
||||||
|
/// Field lookup has to be anchored here. Prose above the section is free text, so a
|
||||||
|
/// description quoting a field marker would otherwise shadow the real value below it.
|
||||||
|
fn metadata_lines(content: &str) -> impl Iterator<Item = &str> {
|
||||||
content
|
content
|
||||||
.lines()
|
.lines()
|
||||||
.find(|line| line.contains(&pattern))
|
.skip_while(|line| !is_metadata_heading(line))
|
||||||
.map(|line| {
|
.skip(1)
|
||||||
line.splitn(2, &pattern)
|
.take_while(|line| !line.starts_with("## "))
|
||||||
.nth(1)
|
}
|
||||||
.unwrap_or("_Not set_")
|
|
||||||
.trim()
|
/// A metadata line without its list marker, so lookup can match on a prefix rather
|
||||||
.to_string()
|
/// than searching the whole line.
|
||||||
})
|
fn metadata_field_body(line: &str) -> &str {
|
||||||
.unwrap_or("_Not set_".to_string())
|
let line = line.trim_start();
|
||||||
|
line.strip_prefix("- ").unwrap_or(line)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn parse_ticket_field(content: &str, field: &str) -> String {
|
||||||
|
let prefix = format!("**{}**:", field);
|
||||||
|
metadata_lines(content)
|
||||||
|
.find_map(|line| metadata_field_body(line).strip_prefix(&prefix))
|
||||||
|
.map(|value| value.trim().to_string())
|
||||||
|
.unwrap_or_else(|| "_Not set_".to_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn is_status_line(line: &str) -> bool {
|
fn is_status_line(line: &str) -> bool {
|
||||||
|
let body = metadata_field_body(line);
|
||||||
// The second spelling is what earlier versions wrote, repair it on the way through.
|
// The second spelling is what earlier versions wrote, repair it on the way through.
|
||||||
line.starts_with("- **Status**:") || line.starts_with("- **-Status**:")
|
body.starts_with("**Status**:") || body.starts_with("**-Status**:")
|
||||||
}
|
}
|
||||||
|
|
||||||
// Rewrite the Status field in the Metadata section, leaving every other line untouched.
|
// Rewrite the Status field in the Metadata section, leaving every other line untouched.
|
||||||
|
//
|
||||||
|
// Scoped to the section for the same reason as parse_ticket_field: a description line
|
||||||
|
// shaped like the Status field would otherwise be rewritten in its place, corrupting
|
||||||
|
// the prose and leaving the real metadata stale.
|
||||||
pub fn set_status_field(content: &str, target_status: &str, title: &str) -> Result<String> {
|
pub fn set_status_field(content: &str, target_status: &str, title: &str) -> Result<String> {
|
||||||
let mut updated = String::with_capacity(content.len());
|
let mut updated = String::with_capacity(content.len());
|
||||||
|
let mut in_metadata = false;
|
||||||
let mut found = false;
|
let mut found = false;
|
||||||
|
|
||||||
for line in content.lines() {
|
for line in content.lines() {
|
||||||
if !found && is_status_line(line) {
|
if line.starts_with("## ") {
|
||||||
|
in_metadata = is_metadata_heading(line);
|
||||||
|
}
|
||||||
|
|
||||||
|
if in_metadata && !found && is_status_line(line) {
|
||||||
updated.push_str("- **Status**: ");
|
updated.push_str("- **Status**: ");
|
||||||
updated.push_str(target_status);
|
updated.push_str(target_status);
|
||||||
found = true;
|
found = true;
|
||||||
@@ -540,19 +628,24 @@ impl Priority {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn parse_priority(content: &str) -> Priority {
|
/// A priority from the value alone, for callers that already have it in hand.
|
||||||
let raw = parse_ticket_field(content, "Priority");
|
pub fn priority_from_value(raw: &str) -> Priority {
|
||||||
|
let raw = raw.trim();
|
||||||
|
|
||||||
if is_unknown_value(&raw) {
|
if is_unknown_value(raw) {
|
||||||
return Priority::Unset;
|
return Priority::Unset;
|
||||||
}
|
}
|
||||||
|
|
||||||
match raw.trim().parse::<u8>() {
|
match raw.parse::<u8>() {
|
||||||
Ok(level) if PRIORITY_RANGE.contains(&level) => Priority::Level(level),
|
Ok(level) if PRIORITY_RANGE.contains(&level) => Priority::Level(level),
|
||||||
_ => Priority::Invalid,
|
_ => Priority::Invalid,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn parse_priority(content: &str) -> Priority {
|
||||||
|
priority_from_value(&parse_ticket_field(content, "Priority"))
|
||||||
|
}
|
||||||
|
|
||||||
pub struct TicketItem {
|
pub struct TicketItem {
|
||||||
pub title: String,
|
pub title: String,
|
||||||
pub owner: String,
|
pub owner: String,
|
||||||
@@ -564,11 +657,11 @@ pub struct TicketItem {
|
|||||||
|
|
||||||
/// Grey for a value that is not set, per the colour guideline.
|
/// Grey for a value that is not set, per the colour guideline.
|
||||||
///
|
///
|
||||||
/// `show` already did this through `colorize_metadata`, so the listing was the
|
/// `show` already did this in its metadata rendering, so the listing was the one
|
||||||
/// one place that ignored the rule.
|
/// place that ignored the rule.
|
||||||
fn dim_if_unset(value: &str) -> String {
|
fn dim_if_unset(value: &str, colored: bool) -> String {
|
||||||
if is_unknown_value(value) {
|
if is_unknown_value(value) {
|
||||||
color_text(value, "grey")
|
paint(value, "grey", colored)
|
||||||
} else {
|
} else {
|
||||||
value.to_string()
|
value.to_string()
|
||||||
}
|
}
|
||||||
@@ -617,17 +710,19 @@ pub fn priority_legend() -> String {
|
|||||||
format!("Priority: {levels} {unset} unset 1 is most urgent")
|
format!("Priority: {levels} {unset} unset 1 is most urgent")
|
||||||
}
|
}
|
||||||
|
|
||||||
fn show_priority(priority: Priority) -> String {
|
fn show_priority(priority: Priority, colored: bool) -> String {
|
||||||
let (glyph, colour) = priority_mark(priority);
|
let (glyph, colour) = priority_mark(priority);
|
||||||
color_text(glyph, colour)
|
paint(glyph, colour, colored)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn display_ticket_items(items: &[TicketItem]) {
|
pub fn display_ticket_items(items: &[TicketItem]) {
|
||||||
|
let colored = should_use_colors();
|
||||||
|
|
||||||
for item in items {
|
for item in items {
|
||||||
let id = color_text(&item.id, "red");
|
let id = paint(&item.id, "red", colored);
|
||||||
let owner = dim_if_unset(&item.owner);
|
let owner = dim_if_unset(&item.owner, colored);
|
||||||
let due = dim_if_unset(&item.due);
|
let due = dim_if_unset(&item.due, colored);
|
||||||
let priority = show_priority(item.priority);
|
let priority = show_priority(item.priority, colored);
|
||||||
|
|
||||||
if item.created.is_empty() {
|
if item.created.is_empty() {
|
||||||
println!(
|
println!(
|
||||||
@@ -635,7 +730,7 @@ pub fn display_ticket_items(items: &[TicketItem]) {
|
|||||||
priority, id, item.title, owner, due
|
priority, id, item.title, owner, due
|
||||||
);
|
);
|
||||||
} else {
|
} else {
|
||||||
let created = color_text(&item.created, "cyan");
|
let created = paint(&item.created, "cyan", colored);
|
||||||
println!(
|
println!(
|
||||||
" {} {} ({}) {} | Owner: {} | Due: {}",
|
" {} {} ({}) {} | Owner: {} | Due: {}",
|
||||||
priority, created, id, item.title, owner, due
|
priority, created, id, item.title, owner, due
|
||||||
@@ -717,15 +812,18 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn unset_values_are_dimmed_and_set_ones_are_not() {
|
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
|
// Both paths, now that the colour decision is a parameter: with colour off the
|
||||||
|
// text has to come back untouched, with it on only the unset values get wrapped
|
||||||
for unset in ["_Not set_", "_None_"] {
|
for unset in ["_Not set_", "_None_"] {
|
||||||
assert!(is_unknown_value(unset), "{unset} should count as unset");
|
assert!(is_unknown_value(unset), "{unset} should count as unset");
|
||||||
assert_eq!(dim_if_unset(unset), unset);
|
assert_eq!(dim_if_unset(unset, false), unset);
|
||||||
|
assert_eq!(dim_if_unset(unset, true), paint(unset, "grey", true));
|
||||||
}
|
}
|
||||||
|
|
||||||
for set in ["alice", "2026-12-31", "bug,frontend"] {
|
for set in ["alice", "2026-12-31", "bug,frontend"] {
|
||||||
assert!(!is_unknown_value(set));
|
assert!(!is_unknown_value(set));
|
||||||
assert_eq!(dim_if_unset(set), set);
|
assert_eq!(dim_if_unset(set, false), set);
|
||||||
|
assert_eq!(dim_if_unset(set, true), set);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -733,6 +831,262 @@ mod tests {
|
|||||||
format!("# T\n\n## Metadata\n\n- **Priority**: {}\n", raw)
|
format!("# T\n\n## Metadata\n\n- **Priority**: {}\n", raw)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A ticket whose prose quotes the field markers it also carries as metadata,
|
||||||
|
/// as a list so the quoted lines start with the marker. This repo files tickets
|
||||||
|
/// about the metadata format, so it is the normal case here rather than a corner.
|
||||||
|
fn ticket_shadowing_its_own_metadata() -> String {
|
||||||
|
"# Shadow\n\
|
||||||
|
\n\
|
||||||
|
## Description\n\
|
||||||
|
The current format is:\n\
|
||||||
|
- **Owner**: nobody\n\
|
||||||
|
- **Status**: backlog\n\
|
||||||
|
\n\
|
||||||
|
## Metadata\n\
|
||||||
|
\n\
|
||||||
|
- **ID**: real-id\n\
|
||||||
|
- **Owner**: alice\n\
|
||||||
|
- **Status**: backlog\n"
|
||||||
|
.to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn prose_quoting_a_field_marker_does_not_shadow_the_metadata() {
|
||||||
|
let content = ticket_shadowing_its_own_metadata();
|
||||||
|
assert_eq!(parse_ticket_field(&content, "Owner"), "alice");
|
||||||
|
assert_eq!(parse_ticket_field(&content, "ID"), "real-id");
|
||||||
|
assert_eq!(parse_ticket_field(&content, "Status"), "backlog");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_field_only_mentioned_in_prose_reads_as_unset() {
|
||||||
|
let content = "# T\n\n## Description\n- **Due**: 2026-12-31\n\n## Metadata\n\n- **ID**: x\n";
|
||||||
|
assert_eq!(parse_ticket_field(content, "Due"), "_Not set_");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_field_lookup_needs_the_metadata_heading() {
|
||||||
|
// No section, no fields: there is nothing to anchor to.
|
||||||
|
assert_eq!(
|
||||||
|
parse_ticket_field("# T\n\n- **Owner**: alice\n", "Owner"),
|
||||||
|
"_Not set_"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_field_lookup_stops_at_the_next_section() {
|
||||||
|
let content = "# T\n\n## Metadata\n\n- **ID**: x\n\n## Notes\n\n- **Owner**: alice\n";
|
||||||
|
assert_eq!(parse_ticket_field(content, "Owner"), "_Not set_");
|
||||||
|
assert_eq!(parse_ticket_field(content, "ID"), "x");
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Matching on a prefix, not a substring: a field name inside another field's
|
||||||
|
/// value is not that field.
|
||||||
|
#[test]
|
||||||
|
fn a_field_marker_inside_another_value_is_not_matched() {
|
||||||
|
let content = "# T\n\n## Metadata\n\n- **Tags**: mentions **Owner**: bob\n";
|
||||||
|
assert_eq!(parse_ticket_field(content, "Owner"), "_Not set_");
|
||||||
|
assert_eq!(parse_ticket_field(content, "Tags"), "mentions **Owner**: bob");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn setting_the_status_leaves_prose_that_looks_like_metadata_alone() {
|
||||||
|
let content = ticket_shadowing_its_own_metadata();
|
||||||
|
let updated = set_status_field(&content, "committed", "Shadow").unwrap();
|
||||||
|
|
||||||
|
assert!(
|
||||||
|
updated.contains("## Description\nThe current format is:\n- **Owner**: nobody\n- **Status**: backlog\n"),
|
||||||
|
"the description was rewritten:\n{updated}"
|
||||||
|
);
|
||||||
|
assert_eq!(parse_ticket_field(&updated, "Status"), "committed");
|
||||||
|
assert_eq!(updated.matches("**Status**: committed").count(), 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn setting_the_status_needs_the_field_in_the_metadata_section() {
|
||||||
|
// A Status line above the section is prose, so this is a ticket without the field.
|
||||||
|
let content = "# T\n\n## Description\n- **Status**: backlog\n\n## Metadata\n\n- **ID**: x\n";
|
||||||
|
assert!(set_status_field(content, "committed", "T").is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
/// SGR escapes removed, so a rendered cell can be measured as it lands on screen.
|
||||||
|
/// Test-only: production never measures a styled string, which is the point.
|
||||||
|
fn unstyled(text: &str) -> String {
|
||||||
|
let mut out = String::new();
|
||||||
|
let mut chars = text.chars();
|
||||||
|
|
||||||
|
while let Some(c) = chars.next() {
|
||||||
|
if c != '\x1b' {
|
||||||
|
out.push(c);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
// Drop everything up to and including the 'm' that closes the sequence.
|
||||||
|
for c in chars.by_ref() {
|
||||||
|
if c == 'm' {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_metadata_table_aligns_values_in_one_column() {
|
||||||
|
// The leading blank line is what the ticket template writes under the heading.
|
||||||
|
let rendered = render_metadata_table(
|
||||||
|
&[
|
||||||
|
"",
|
||||||
|
"- **ID**: abc",
|
||||||
|
"- **Created At**: 2026-08-20",
|
||||||
|
"- **Owner**: alice",
|
||||||
|
],
|
||||||
|
false,
|
||||||
|
);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
rendered,
|
||||||
|
"ID abc\n\
|
||||||
|
Created At 2026-08-20\n\
|
||||||
|
Owner alice\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_long_field_name_widens_the_column_for_every_row() {
|
||||||
|
let rendered =
|
||||||
|
render_metadata_table(&["- **ID**: abc", "- **Handled By Team**: ops"], false);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
rendered,
|
||||||
|
"ID abc\n\
|
||||||
|
Handled By Team ops\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The trap the ticket names: field names are coloured, unset values are greyed
|
||||||
|
/// and Priority carries a mark, so measuring the styled text would tilt the table
|
||||||
|
/// with colour on and not with it off.
|
||||||
|
#[test]
|
||||||
|
fn colour_does_not_change_the_alignment() {
|
||||||
|
let lines = [
|
||||||
|
"- **ID**: abc",
|
||||||
|
"- **Priority**: 2",
|
||||||
|
"- **Due**: _Not set_",
|
||||||
|
"- **Owner**: Ansho Rei",
|
||||||
|
];
|
||||||
|
|
||||||
|
let plain = render_metadata_table(&lines, false);
|
||||||
|
let coloured = render_metadata_table(&lines, true);
|
||||||
|
|
||||||
|
assert_ne!(coloured, plain, "colour produced no escapes at all");
|
||||||
|
assert_eq!(unstyled(&coloured), plain);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_non_ascii_field_name_is_measured_in_characters() {
|
||||||
|
// "Créé à" is 6 characters and 8 bytes, so a byte-width column pads it short
|
||||||
|
let rendered = render_metadata_table(&["- **Créé à**: oui", "- **ID**: abc"], false);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
rendered,
|
||||||
|
"Créé à oui\n\
|
||||||
|
ID abc\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_non_ascii_value_leaves_the_column_alone() {
|
||||||
|
let lines = ["- **Owner**: 日本語", "- **ID**: abc"];
|
||||||
|
let rendered = render_metadata_table(&lines, false);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
rendered,
|
||||||
|
"Owner 日本語\n\
|
||||||
|
ID abc\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_field_the_tool_does_not_know_still_gets_a_row() {
|
||||||
|
let rendered = render_metadata_table(&["- **ID**: abc", "- **Sprint**: 14"], false);
|
||||||
|
|
||||||
|
assert!(rendered.contains("Sprint 14"), "{rendered:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_line_that_is_not_a_field_is_carried_through() {
|
||||||
|
let rendered =
|
||||||
|
render_metadata_table(&["- **ID**: abc", "a hand written note"], false);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
rendered,
|
||||||
|
"ID abc\n\
|
||||||
|
a hand written note\n"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_priority_cell_carries_the_mark_and_the_stored_number() {
|
||||||
|
let rendered = render_metadata_table(&["- **Priority**: 2"], false);
|
||||||
|
let (glyph, _) = priority_mark(Priority::Level(2));
|
||||||
|
|
||||||
|
assert_eq!(rendered, format!("Priority {glyph} 2\n"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn an_unset_priority_reads_as_unset_in_the_table() {
|
||||||
|
let rendered = render_metadata_table(&["- **Priority**: _Not set_"], false);
|
||||||
|
let (glyph, _) = priority_mark(Priority::Unset);
|
||||||
|
|
||||||
|
assert_eq!(rendered, format!("Priority {glyph} _Not set_\n"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_section_rule_matches_the_width_of_its_name() {
|
||||||
|
let rendered = content_trim_colored("# T\n\n## Description\nbody\n");
|
||||||
|
|
||||||
|
// Eleven characters, not fourteen: the rule used to span "## Description"
|
||||||
|
assert!(
|
||||||
|
rendered.starts_with("Description\n───────────\n"),
|
||||||
|
"{rendered:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_non_ascii_section_name_is_not_over_drawn() {
|
||||||
|
let rendered = content_trim_colored("# T\n\n## Résumé\nbody\n");
|
||||||
|
|
||||||
|
assert!(rendered.starts_with("Résumé\n──────\n"), "{rendered:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_body_leaves_the_title_to_cmd_show() {
|
||||||
|
let rendered = content_trim_colored("# Only Once\n\n## Description\nbody\n");
|
||||||
|
|
||||||
|
assert!(!rendered.contains("Only Once"), "{rendered:?}");
|
||||||
|
// And no gap where it was
|
||||||
|
assert!(rendered.starts_with("Description"), "{rendered:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_metadata_section_renders_as_a_table_inside_the_body() {
|
||||||
|
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n- **Owner**: alice\n";
|
||||||
|
let rendered = content_trim_colored(content);
|
||||||
|
|
||||||
|
assert_eq!(rendered, "Metadata\n────────\n\nID abc\nOwner alice\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_section_after_metadata_still_renders() {
|
||||||
|
let content = "# T\n\n## Metadata\n\n- **ID**: abc\n\n## Notes\n\nafter\n";
|
||||||
|
let rendered = content_trim_colored(content);
|
||||||
|
|
||||||
|
assert!(rendered.contains("ID abc"), "{rendered:?}");
|
||||||
|
assert!(rendered.contains("Notes\n─────\n"), "{rendered:?}");
|
||||||
|
assert!(rendered.ends_with("after\n"), "{rendered:?}");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_level_in_range_parses() {
|
fn a_level_in_range_parses() {
|
||||||
for level in 1..=5u8 {
|
for level in 1..=5u8 {
|
||||||
|
|||||||
@@ -420,3 +420,68 @@ fn show_renders_the_priority_mark_beside_the_number() {
|
|||||||
let content = fs::read_to_string(worklane.join("backlog").join(filename)).unwrap();
|
let content = fs::read_to_string(worklane.join("backlog").join(filename)).unwrap();
|
||||||
assert!(content.contains("- **Priority**: 2"));
|
assert!(content.contains("- **Priority**: 2"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn show_prints_the_title_once() {
|
||||||
|
let temp = TempDir::new().unwrap();
|
||||||
|
let worklane = setup_worklane(&temp);
|
||||||
|
|
||||||
|
create_ticket(
|
||||||
|
&worklane,
|
||||||
|
"backlog",
|
||||||
|
"Once Only",
|
||||||
|
"A description that does not name the title.",
|
||||||
|
"abc123def456789012345678901234567890",
|
||||||
|
"alice",
|
||||||
|
"2026-12-31",
|
||||||
|
"test",
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
|
||||||
|
cmd.current_dir(&temp.path()).arg("show").arg("Once Only");
|
||||||
|
let stdout = get_stdout(&mut cmd);
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
stdout.matches("Once Only").count(),
|
||||||
|
1,
|
||||||
|
"title repeated in {stdout:?}"
|
||||||
|
);
|
||||||
|
// The rule under it is still the width of the title
|
||||||
|
assert!(stdout.contains("Once Only\n─────────\n"), "{stdout:?}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn show_renders_the_metadata_as_an_aligned_table() {
|
||||||
|
let temp = TempDir::new().unwrap();
|
||||||
|
let worklane = setup_worklane(&temp);
|
||||||
|
|
||||||
|
let filename = "abc123def456789012345678901234567890_table.md";
|
||||||
|
fs::write(
|
||||||
|
worklane.join("backlog").join(filename),
|
||||||
|
"# Table Ticket\n\n## Metadata\n\n\
|
||||||
|
- **ID**: abc123def456789012345678901234567890\n\
|
||||||
|
- **Created At**: 2026-08-20 15:51:01\n\
|
||||||
|
- **Owner**: alice\n\
|
||||||
|
- **Status**: backlog\n",
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
let mut cmd = Command::cargo_bin(BIN_NAME).unwrap();
|
||||||
|
cmd.current_dir(&temp.path()).arg("show").arg("Table");
|
||||||
|
let stdout = get_stdout(&mut cmd);
|
||||||
|
|
||||||
|
// Every value starts in the same column, sized by the longest field name
|
||||||
|
assert!(
|
||||||
|
stdout.contains(
|
||||||
|
"ID abc123def456789012345678901234567890\n\
|
||||||
|
Created At 2026-08-20 15:51:01\n\
|
||||||
|
Owner alice\n\
|
||||||
|
Status backlog\n"
|
||||||
|
),
|
||||||
|
"{stdout:?}"
|
||||||
|
);
|
||||||
|
|
||||||
|
// Display only: the file is still the markdown list it was
|
||||||
|
let content = fs::read_to_string(worklane.join("backlog").join(filename)).unwrap();
|
||||||
|
assert!(content.contains("- **Owner**: alice"));
|
||||||
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user