iris/TODO.md

1.8 KiB

Epics

MVP: Complete!

Reading/Status: Complete!

Editing/Deleting: In Progress

Documentation: In Progress

  • Add command-line options to README
  • Flesh out technical sections

Bugs:

  • Fix topic selection when replying without topic ID
  • Is Time.now.utc.iso8601 working as expected?

Tech debt:

  • Flesh out tests
  • Add integration tests
  • Create Struct to firm up message payload
  • Let Message initialization accept params as a hash
  • Add check for message file format version

Refactoring

  • Split helptext into separate file?

Features:

  • Message deletion
  • Message editing
    • Allow shelling out to editor for message editing?
  • Gracefully handle bad message files
  • Add read-only mode if user doesn't want/can't have message file
  • Add user muting (~/.iris.muted)
  • Add message editing
  • JSON API mode
  • Check message file size before loading, to prevent giant files from bombing the system.
  • Add stats to interactive interface

Fancify interface:

  • Add (read/unread) counts to topic line
  • Add reader/user count to stats
  • Gracefully handle attempt to "r 1 message"
  • Highlight names for readability
  • Readline.completion_proc for tab completion
  • Pagination?
  • Add optional title for topics
  • Add message when no topics are found
  • Add message troubleshooting tool, for deep data dive
  • Add option to skip color

Icebox

  • ncurses client
  • customizable prompt
  • MOTD
  • Add to default startup script to display read count
  • Common message file location for the security-conscious
  • JSON -> SSI -> Javascript webreader

Completed

  • Make all output WIDTH-aware
  • Add color
  • Add full message corpus dump for backup/debugging
  • Add startup enviro health check
  • Change listing to show last updated timestamp, instead of thread creation timestamp
  • Add command-line options to README
  • Add documentation for color feature