Instruction file imported from Pranav-Karra-3301/tuck (.cursor/rules/ui.mdc). Copyright stays with the author.

UI Rules

Color Palette

Command Structure

Every command should follow this pattern:

prompts.intro('tuck commandname');

// ... work with spinners/progress ...

prompts.note("Run 'tuck next' to continue", 'Next step');
prompts.outro('Done!');

Spinners

Use for operations >100ms:

const spinner = prompts.spinner();
spinner.start('Processing files...');

try {
  await doWork();
  spinner.stop('Processed 5 files');
} catch (error) {
  spinner.stop('Failed to process');
  throw error;
}

Progress Feedback

For multi-step operations:

1. Show what's being done
2. Show progress (X of Y)
3. Show completion status

prompts.log.step(`Syncing file ${i}/${total}: ${filename}`);

Confirmations

ALWAYS confirm destructive actions:

const confirmed = await prompts.confirm(
  'Delete all backups?',
  false  // Default to NO (safe option)
);

if (!confirmed) {
  prompts.cancel('Operation cancelled');
  return;
}

Error Messages

Provide helpful, actionable errors:

// Good
throw new FileNotFoundError(path, {
  suggestion: "Run 'tuck add' first to track this file"
});

// Bad
throw new Error('File not found');

Interactive Mode

Every command should support:

• Interactive mode (default) - prompts for input
• Non-interactive mode (--yes, --force) - for scripts

Next Steps

Always end successful operations with guidance:

prompts.note("Run 'tuck push' to upload changes", 'Next step');