Skip to content

feat(custom-command): cache output behind an opt-in TTL and honor the timeout #539

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zachthedev wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(custom-command): cache output behind an opt-in TTL and honor the timeout #539

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9da75b8
feat(custom-command): cache command output behind a configurable TTL
zachthedev Aug 5, 2026
6adc983
fix(custom-command): honor the timeout and kill the shell's process tree
zachthedev Aug 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/ccstatusline.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ async function renderMultipleLines(data: StatusJSON) {
isPreview: false,
minimalist: settings.minimalistMode,
gitCacheTtlSeconds: settings.gitCacheTtlSeconds,
customCommandCacheTtlSeconds: settings.customCommandCacheTtlSeconds,
gitReviewNeedsChecks: lines.some(line => line.some(item => item.type === 'git-ci-status'))
};

Expand Down
12 changes: 12 additions & 0 deletions src/tui/App.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,7 @@ export const App: React.FC = () => {
currentInterval={currentRefreshInterval}
supportsRefreshInterval={supportsRefreshInterval}
gitCacheTtlSeconds={settings.gitCacheTtlSeconds}
customCommandCacheTtlSeconds={settings.customCommandCacheTtlSeconds}
onUpdate={(interval) => {
const previous = currentRefreshInterval;
setCurrentRefreshInterval(interval);
Expand Down Expand Up @@ -1390,6 +1391,17 @@ export const App: React.FC = () => {
});
setScreen('main');
}}
onCustomCommandCacheTtlUpdate={(ttlSeconds) => {
setSettings({
...settings,
customCommandCacheTtlSeconds: ttlSeconds
});
setFlashMessage({
text: '✓ Custom command cache TTL updated',
color: 'green'
});
setScreen('main');
}}
onBack={() => {
setScreen('main');
}}
Expand Down
113 changes: 87 additions & 26 deletions src/tui/components/RefreshIntervalMenu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ import {
type ListEntry
} from './List';

type ConfigureStatusLineValue = 'refreshInterval' | 'gitCacheTtl';
type TtlField = 'gitCacheTtl' | 'customCommandCacheTtl';
type ConfigureStatusLineValue = 'refreshInterval' | TtlField;

function getRefreshInputValue(interval: number | null): string {
return interval === null ? '' : String(interval);
Expand All @@ -36,10 +37,17 @@ function getGitCacheTtlSublabel(ttlSeconds: number): string {
: `(${ttlSeconds}s)`;
}

function getCustomCommandCacheTtlSublabel(ttlSeconds: number): string {
return ttlSeconds === 0
? '(disabled)'
: `(${ttlSeconds}s)`;
}

export function buildConfigureStatusLineItems(
refreshInterval: number | null,
supportsRefreshInterval: boolean,
gitCacheTtlSeconds: number
gitCacheTtlSeconds: number,
customCommandCacheTtlSeconds: number
): ListEntry<ConfigureStatusLineValue>[] {
return [
{
Expand All @@ -56,6 +64,12 @@ export function buildConfigureStatusLineItems(
sublabel: getGitCacheTtlSublabel(gitCacheTtlSeconds),
value: 'gitCacheTtl',
description: 'How long git widget subprocess output can be reused while .git/HEAD and .git/index are unchanged. Enter 0-60 seconds;\n0 disables age-based expiry, so cached output is reused until those git metadata mtimes change.'
},
{
label: '🔧 Custom Command Cache TTL',
sublabel: getCustomCommandCacheTtlSublabel(customCommandCacheTtlSeconds),
value: 'customCommandCacheTtl',
description: 'How long custom command output is reused before the command runs again. Enter 0-60 seconds;\n0 disables caching, so every status line render spawns the command.'
}
];
}
Expand All @@ -82,47 +96,87 @@ export function validateRefreshIntervalInput(value: string): string | null {
return null;
}

export function validateGitCacheTtlInput(value: string): string | null {
function validateTtlInput(value: string, label: string): string | null {
const parsed = parseInt(value, 10);

if (value === '' || isNaN(parsed)) {
return 'Please enter a valid number';
}

if (parsed < 0) {
return `Minimum Git cache TTL is 0s (you entered ${parsed}s)`;
return `Minimum ${label} is 0s (you entered ${parsed}s)`;
}

if (parsed > 60) {
return `Maximum Git cache TTL is 60s (you entered ${parsed}s)`;
return `Maximum ${label} is 60s (you entered ${parsed}s)`;
}

return null;
}

export function validateGitCacheTtlInput(value: string): string | null {
return validateTtlInput(value, 'Git cache TTL');
}

export function validateCustomCommandCacheTtlInput(value: string): string | null {
return validateTtlInput(value, 'custom command cache TTL');
}

interface TtlFieldConfig {
currentValue: number;
prompt: string;
helperText: string;
hint: string;
validate: (value: string) => string | null;
onSave: (ttlSeconds: number) => void;
}

export interface RefreshIntervalMenuProps {
currentInterval: number | null;
supportsRefreshInterval: boolean;
gitCacheTtlSeconds: number;
customCommandCacheTtlSeconds: number;
onUpdate: (interval: number | null) => void;
onGitCacheTtlUpdate: (ttlSeconds: number) => void;
onCustomCommandCacheTtlUpdate: (ttlSeconds: number) => void;
onBack: () => void;
}

export const RefreshIntervalMenu: React.FC<RefreshIntervalMenuProps> = ({
currentInterval,
supportsRefreshInterval,
gitCacheTtlSeconds,
customCommandCacheTtlSeconds,
onUpdate,
onGitCacheTtlUpdate,
onCustomCommandCacheTtlUpdate,
onBack
}) => {
const [editingRefreshInterval, setEditingRefreshInterval] = useState(false);
const [editingGitCacheTtl, setEditingGitCacheTtl] = useState(false);
const [editingTtlField, setEditingTtlField] = useState<TtlField | null>(null);
const [refreshInput, setRefreshInput] = useState(() => getRefreshInputValue(currentInterval));
const [gitCacheTtlInput, setGitCacheTtlInput] = useState(() => String(gitCacheTtlSeconds));
const [ttlInput, setTtlInput] = useState(() => String(gitCacheTtlSeconds));
const [validationError, setValidationError] = useState<string | null>(null);

const ttlFields: Record<TtlField, TtlFieldConfig> = {
gitCacheTtl: {
currentValue: gitCacheTtlSeconds,
prompt: 'Enter Git cache TTL in seconds (0-60):',
helperText: 'This affects how quickly git widgets notice unstaged and untracked working-tree changes.',
hint: '0 disables age-based expiry; cache validity uses .git/HEAD and .git/index mtimes only.',
validate: validateGitCacheTtlInput,
onSave: onGitCacheTtlUpdate
},
customCommandCacheTtl: {
currentValue: customCommandCacheTtlSeconds,
prompt: 'Enter custom command cache TTL in seconds (0-60):',
helperText: 'This affects how quickly custom command widgets show new output, and how often they spawn a shell.',
hint: '0 disables caching; every status line render spawns the command again.',
validate: validateCustomCommandCacheTtlInput,
onSave: onCustomCommandCacheTtlUpdate
}
};

useInput((input, key) => {
if (editingRefreshInterval) {
if (key.return) {
Expand Down Expand Up @@ -162,31 +216,33 @@ export const RefreshIntervalMenu: React.FC<RefreshIntervalMenuProps> = ({
return;
}

if (editingGitCacheTtl) {
if (editingTtlField) {
const field = ttlFields[editingTtlField];

if (key.return) {
const error = validateGitCacheTtlInput(gitCacheTtlInput);
const error = field.validate(ttlInput);

if (error) {
setValidationError(error);
} else {
const value = parseInt(gitCacheTtlInput, 10);
onGitCacheTtlUpdate(value);
setEditingGitCacheTtl(false);
const value = parseInt(ttlInput, 10);
field.onSave(value);
setEditingTtlField(null);
setValidationError(null);
}
} else if (key.escape) {
setGitCacheTtlInput(String(gitCacheTtlSeconds));
setEditingGitCacheTtl(false);
setTtlInput(String(field.currentValue));
setEditingTtlField(null);
setValidationError(null);
} else if (key.backspace) {
setGitCacheTtlInput(gitCacheTtlInput.slice(0, -1));
setTtlInput(ttlInput.slice(0, -1));
setValidationError(null);
} else if (key.delete) {
// No cursor position in simple input
} else if (shouldInsertInput(input, key) && /\d/.test(input)) {
const newValue = gitCacheTtlInput + input;
const newValue = ttlInput + input;
if (newValue.length <= 2) {
setGitCacheTtlInput(newValue);
setTtlInput(newValue);
setValidationError(null);
}
}
Expand Down Expand Up @@ -217,31 +273,36 @@ export const RefreshIntervalMenu: React.FC<RefreshIntervalMenuProps> = ({
<Text dimColor>Press Enter to confirm, ESC to cancel. Leave empty to remove.</Text>
)}
</Box>
) : editingGitCacheTtl ? (
) : editingTtlField ? (
<Box marginTop={1} flexDirection='column'>
<Text>
Enter Git cache TTL in seconds (0-60):
{ttlFields[editingTtlField].prompt}
{' '}
{gitCacheTtlInput}
{gitCacheTtlInput.length > 0 ? 's' : ''}
{ttlInput}
{ttlInput.length > 0 ? 's' : ''}
</Text>
<Text> </Text>
<Text dimColor wrap='wrap'>
This affects how quickly git widgets notice unstaged and untracked working-tree changes.
{ttlFields[editingTtlField].helperText}
</Text>
{validationError ? (
<Text color='red'>{validationError}</Text>
) : (
<Text dimColor>
0 disables age-based expiry; cache validity uses .git/HEAD and .git/index mtimes only.
{ttlFields[editingTtlField].hint}
</Text>
)}
<Text dimColor>Press Enter to confirm, ESC to cancel.</Text>
</Box>
) : (
<List
marginTop={1}
items={buildConfigureStatusLineItems(currentInterval, supportsRefreshInterval, gitCacheTtlSeconds)}
items={buildConfigureStatusLineItems(
currentInterval,
supportsRefreshInterval,
gitCacheTtlSeconds,
customCommandCacheTtlSeconds
)}
onSelect={(value) => {
if (value === 'back') {
onBack();
Expand All @@ -254,8 +315,8 @@ export const RefreshIntervalMenu: React.FC<RefreshIntervalMenuProps> = ({
return;
}

setGitCacheTtlInput(String(gitCacheTtlSeconds));
setEditingGitCacheTtl(true);
setTtlInput(String(ttlFields[value].currentValue));
setEditingTtlField(value);
}}
showBackButton={true}
/>
Expand Down
4 changes: 3 additions & 1 deletion src/tui/components/StatusLinePreview.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const renderSingleLine = (
isPreview: true,
minimalist: settings.minimalistMode,
gitCacheTtlSeconds: settings.gitCacheTtlSeconds,
customCommandCacheTtlSeconds: settings.customCommandCacheTtlSeconds,
lineIndex,
globalSeparatorIndex,
globalPowerlineThemeIndex,
Expand Down Expand Up @@ -77,7 +78,8 @@ export const StatusLinePreview: React.FC<StatusLinePreviewProps> = ({ lines, ter
terminalWidth,
isPreview: true,
minimalist: settings.minimalistMode,
gitCacheTtlSeconds: settings.gitCacheTtlSeconds
gitCacheTtlSeconds: settings.gitCacheTtlSeconds,
customCommandCacheTtlSeconds: settings.customCommandCacheTtlSeconds
});
const preCalculatedMaxWidths = calculateMaxWidthsFromPreRendered(preRenderedLines, settings);

Expand Down
Loading