Files
gitea-axi/src/fields.ts
alexion b5955cd7b8
All checks were successful
CI / test (pull_request) Successful in 49s
CI / test (push) Successful in 49s
feat: truncate --fields body uniformly (task 0021)
Rule that the `body` extra field truncates at 500 chars like `issue view`,
resolving the spec's Principle 3 / Command Surface contradiction. Route the
`body` extractor through a new `truncatedBody()` FieldDef so `issue list`,
`issue create`, `pr list`, and `search` all present it exactly as the detail
views do, and add a `--full` flag to each to suppress truncation, keeping the
inline hint's "use --full" promise honest.
2026-07-14 12:23:24 -04:00

157 lines
4.6 KiB
TypeScript

import { BODY_TRUNCATE_LIMIT, truncateBody } from "./body.js";
import { axiError } from "./errors.js";
import { relativeTime } from "./time.js";
export interface ExtractContext {
now: Date;
/** Hostname for `cleanBody`'s Gitea URL normalization when a body is truncated. */
host: string;
/** When set, `truncatedBody` returns the raw body — the `--full` affordance. */
full: boolean;
}
export interface FieldDef<T> {
name: string;
extract: (raw: T, context: ExtractContext) => unknown;
}
function pluckPath(raw: unknown, path: string): unknown {
let value: unknown = raw;
for (const key of path.split(".")) {
if (typeof value !== "object" || value === null) {
return undefined;
}
value = (value as Record<string, unknown>)[key];
}
return value;
}
export function pluck<T>(name: string, path: string = name): FieldDef<T> {
return { name, extract: (raw) => pluckPath(raw, path) ?? "" };
}
export function lowercased<T>(name: string, path: string = name): FieldDef<T> {
return {
name,
extract: (raw) => String(pluckPath(raw, path) ?? "").toLowerCase(),
};
}
/**
* Render a boolean field as one of two words (default `yes`/`no`). A missing or
* falsy value reads as the `no` text, so an absent `draft` flag is reported as
* the ordinary non-draft it represents rather than blank.
*/
export function boolText<T>(
name: string,
path: string = name,
yes = "yes",
no = "no",
): FieldDef<T> {
return { name, extract: (raw) => (pluckPath(raw, path) ? yes : no) };
}
/**
* Join a field holding an array of objects (labels, assignees) into a single
* string of each element's `key` property.
*/
export function joined<T>(name: string, path: string, key: string): FieldDef<T> {
return {
name,
extract: (raw) => {
const value = pluckPath(raw, path);
if (!Array.isArray(value)) {
return "";
}
return value
.map((item) => pluckPath(item, key))
.filter((item): item is string => typeof item === "string" && item.length > 0)
.join(", ");
},
};
}
/**
* Render a `body` field under Principle 3's content truncation — identical to
* how `issue view` / `pr view` present a body: over-limit bodies are cleaned and
* cut to 500 chars with the inline "... (truncated, N chars total ...)" hint,
* while short bodies pass through byte-for-byte. `context.full` (the `--full`
* flag) suppresses truncation and returns the raw body. This is the single
* ruling applied everywhere `body` is offered via `--fields` (see task 0021):
* `issue list --limit 30 --fields body` must not spill 30 full bodies into an
* agent's context, the exact cost the truncation principle exists to prevent.
*/
export function truncatedBody<T>(name: string, path: string = name): FieldDef<T> {
return {
name,
extract: (raw, context) => {
const value = String(pluckPath(raw, path) ?? "");
return context.full ? value : truncateBody(value, BODY_TRUNCATE_LIMIT, context.host);
},
};
}
export function relativeTimeField<T>(name: string, path: string): FieldDef<T> {
return {
name,
extract: (raw, context) => {
const value = pluckPath(raw, path);
return relativeTime(typeof value === "string" ? value : undefined, context.now);
},
};
}
/**
* Resolve a comma-separated `--fields` value against the extra fields a command
* offers on top of its defaults. Unknown names are a `VALIDATION_ERROR` naming
* what is available, since a silently ignored field would look like a command
* that returned nothing for it.
*/
export function selectExtraFields<T>(
value: string | undefined,
registry: Record<string, FieldDef<T>>,
command: string,
): FieldDef<T>[] {
if (value === undefined) {
return [];
}
const available = Object.keys(registry);
const suggestion = [
`Run \`gitea-axi ${command} --fields <a,b,c>\` with any of: ${available.join(", ")}`,
];
const selected: FieldDef<T>[] = [];
const seen = new Set<string>();
for (const raw of value.split(",")) {
const name = raw.trim();
if (!name) {
continue;
}
const field = registry[name];
if (!field) {
throw axiError(
`Unknown --fields name: ${name} (available: ${available.join(", ")})`,
"VALIDATION_ERROR",
suggestion,
);
}
if (seen.has(name)) {
continue;
}
seen.add(name);
selected.push(field);
}
return selected;
}
export function extractRow<T>(
raw: T,
fields: FieldDef<T>[],
context: ExtractContext,
): Record<string, unknown> {
const row: Record<string, unknown> = {};
for (const field of fields) {
row[field.name] = field.extract(raw, context);
}
return row;
}