A local-first personal finance app
import Table from 'cli-table3';
export type OutputFormat = 'json' | 'table' | 'csv';
// Fields containing integer-cent values, auto-formatted as decimals in table/csv output.
const AMOUNT_FIELDS = new Set([
'amount',
'balance',
'balance_available',
'balance_current',
'balance_limit',
'budgeted',
'spent',
'carryover',
]);
function isAmountValue(key: string, value: unknown): value is number {
return AMOUNT_FIELDS.has(key) && typeof value === 'number';
}
function formatCellValue(key: string, value: unknown): string {
if (isAmountValue(key, value)) {
return (value / 100).toFixed(2);
}
return String(value ?? '');
}
export function formatOutput(
data: unknown,
format: OutputFormat = 'json',
): string {
switch (format) {
case 'json':
return JSON.stringify(data, null, 2);
case 'table':
return formatTable(data);
case 'csv':
return formatCsv(data);
default:
return JSON.stringify(data, null, 2);
}
}
function formatTable(data: unknown): string {
if (!Array.isArray(data)) {
if (data && typeof data === 'object') {
const table = new Table();
for (const [key, value] of Object.entries(data)) {
table.push({ [key]: formatCellValue(key, value) });
}
return table.toString();
}
return String(data);
}
if (data.length === 0) {
return '(no results)';
}
const keys = Object.keys(data[0] as Record<string, unknown>);
const table = new Table({ head: keys });
for (const row of data) {
const r = row as Record<string, unknown>;
table.push(keys.map(k => formatCellValue(k, r[k])));
}
return table.toString();
}
function formatCsv(data: unknown): string {
if (!Array.isArray(data)) {
if (data && typeof data === 'object') {
const entries = Object.entries(data);
const header = entries.map(([k]) => formatCsvCell('', k)).join(',');
const values = entries.map(([k, v]) => formatCsvCell(k, v)).join(',');
return header + '\n' + values;
}
return typeof data === 'string' ? formatCsvCell('', data) : String(data);
}
if (data.length === 0) {
return '';
}
const keys = Object.keys(data[0] as Record<string, unknown>);
const header = keys.map(k => formatCsvCell('', k)).join(',');
const rows = data.map(row => {
const r = row as Record<string, unknown>;
return keys.map(k => formatCsvCell(k, r[k])).join(',');
});
return [header, ...rows].join('\n');
}
const FORMULA_TRIGGERS = /^\uFEFF*[=+\-@\t\r]/;
function formatCsvCell(key: string, value: unknown): string {
let formatted = formatCellValue(key, value);
// Skip neutralization for numeric values so legitimate negative amounts
// like "-25.00" aren't quoted as text.
if (typeof value !== 'number' && FORMULA_TRIGGERS.test(formatted)) {
formatted = "'" + formatted;
}
return escapeCsv(formatted);
}
function escapeCsv(value: string): string {
if (
value.includes(',') ||
value.includes('"') ||
value.includes('\n') ||
value.includes('\r')
) {
return '"' + value.replace(/"/g, '""') + '"';
}
return value;
}
export function printOutput(data: unknown, format: OutputFormat = 'json') {
process.stdout.write(formatOutput(data, format) + '\n');
}