mirror of https://github.com/Calamitous/iris.git
Update TODO and reorganized to reflect current priorities
This commit is contained in:
parent
53b900e5b3
commit
ff6aedd008
138
TODO.md
138
TODO.md
|
@ -1,87 +1,89 @@
|
||||||
# Epics
|
# Epics
|
||||||
## MVP: Complete!
|
### MVP: Complete!
|
||||||
## Reading/Status: Complete!
|
### Reading/Status: Complete!
|
||||||
## Editing/Deleting: Complete!
|
### Editing/Deleting: Complete!
|
||||||
## Documentation: In Progress
|
### Documentation: In Progress
|
||||||
|
|
||||||
# For 1.0.8
|
# Work Items
|
||||||
* Add less-style pagination for long messages
|
|
||||||
* Add -q/--quiet flag, to create iris message file without user intervention?
|
|
||||||
* Add integration tests
|
|
||||||
* Add ability to run with test iris file
|
|
||||||
* Continue to make loader more durable against corrupted data files
|
|
||||||
* Time to start refactoring!
|
|
||||||
* Health check CLI flag
|
|
||||||
* Create local copies of replied-to messages to limit tampering
|
|
||||||
|
|
||||||
# Bugs:
|
### Documentation
|
||||||
* Is `Time.now.utc.iso8601` working as expected?
|
|
||||||
* Exclude user's own messages from "unread" count
|
|
||||||
* Fix message ordering when editing/deleting multiple messages
|
|
||||||
* Replying implicitly to 24 replied to 6 instead
|
|
||||||
|
|
||||||
# Tech debt:
|
|
||||||
* Flesh out technical sections
|
* Flesh out technical sections
|
||||||
|
|
||||||
|
### Bugs
|
||||||
|
* Is `Time.now.utc.iso8601` working as expected?
|
||||||
|
* Fix bug when people are posting from different time zones
|
||||||
|
* Fix message ordering when editing/deleting multiple messages
|
||||||
|
* Exclude user''s own messages from "unread" count
|
||||||
|
* Replying implicitly to 24 replied to 6 instead
|
||||||
|
* Gracefully handle attempt to "r 1 message"
|
||||||
|
|
||||||
|
### Features
|
||||||
|
* Add pagiation/less for long message lists
|
||||||
|
* https://github.com/Calamitous/iris/issues/1
|
||||||
|
* Allow shelling out to editor for message editing
|
||||||
|
* https://github.com/Calamitous/iris/issues/2
|
||||||
|
* Add local timezone rendering
|
||||||
|
* Add "Mark all read" option
|
||||||
|
* Add option to mark all messages in a thread as read
|
||||||
|
|
||||||
|
### Tech debt
|
||||||
* Flesh out tests
|
* Flesh out tests
|
||||||
|
* Add integration tests
|
||||||
* Create Struct to firm up message payload
|
* Create Struct to firm up message payload
|
||||||
* Let Message initialization accept params as a hash
|
* Let Message initialization accept params as a hash
|
||||||
* Add check for message file format version
|
* Add check for message file format version
|
||||||
* Build entire topic line, _then_ truncate
|
* Build entire topic line, _then_ truncate
|
||||||
|
* Continue to make loader more durable against corrupted data files
|
||||||
|
* Condense generated color codes (color resets are especially noisy)
|
||||||
|
* Check message file size before loading, to prevent giant files from bombing the system.
|
||||||
|
|
||||||
# Refactoring
|
### Backlog
|
||||||
* Split helptext into separate file?
|
* Add reader/user count to stats
|
||||||
|
* Add "already read" message counts to topic line
|
||||||
# Features:
|
* Add "already read" message counts to statistics
|
||||||
* Add ability to fully manage/read messages from CLI?
|
|
||||||
* Add local timezone rendering
|
|
||||||
* Add pagiation/less for long message lists
|
|
||||||
* Add "Mark unread" option
|
* Add "Mark unread" option
|
||||||
* Add read-only mode if user doesn't want/can't have message file
|
* Add read-only mode if user doesn't want/can't have message file
|
||||||
* Add user muting (~/.iris.muted)
|
* 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
|
* Add stats to interactive interface
|
||||||
* Add "private" messages
|
|
||||||
* Allow shelling out to editor for message editing?
|
|
||||||
|
|
||||||
# Fancify interface:
|
|
||||||
* Readline.completion_proc for tab completion
|
* Readline.completion_proc for tab completion
|
||||||
* Pagination?
|
|
||||||
* Add "read" message counts to topic line
|
|
||||||
* Add reader/user count to stats
|
|
||||||
* Gracefully handle attempt to "r 1 message"
|
|
||||||
* Highlight names for readability
|
* Highlight names for readability
|
||||||
* Add optional title for topics
|
|
||||||
* Add message when no topics are found
|
* Add message when no topics are found
|
||||||
* Add message troubleshooting tool, for deep data dive
|
|
||||||
* Add option to skip color
|
* Add option to skip color
|
||||||
* Add option to mark all messages as read
|
|
||||||
* Add option to mark all messages in a thread as read
|
|
||||||
* Condense generated color codes (color resets are especially noisy)
|
|
||||||
|
|
||||||
# Icebox
|
### Icebox
|
||||||
|
* Add message troubleshooting tool, for deep data dive
|
||||||
|
* Add optional title for topics
|
||||||
|
* Health check CLI flag?
|
||||||
|
* Add -q/--quiet flag, to create iris message file without user intervention?
|
||||||
|
* Add "private" messages
|
||||||
|
* JSON API mode
|
||||||
|
* Create local copies of replied-to messages to limit tampering?
|
||||||
|
* Add ability to fully manage/read messages from CLI?
|
||||||
* ncurses client
|
* ncurses client
|
||||||
* customizable prompt
|
* customizable prompt
|
||||||
* MOTD
|
* MOTD/Title?
|
||||||
* Add to default startup script to display read count
|
* Add to default startup script to display read count
|
||||||
* Common message file location for the security-conscious
|
* Common message file location for the security-conscious
|
||||||
* JSON -> SSI -> Javascript webreader
|
* JSON -> SSI -> Javascript webreader
|
||||||
|
|
||||||
---
|
# Changelog
|
||||||
|
|
||||||
# Completed as of 1.0.5
|
## 1.0.10
|
||||||
* Make all output WIDTH-aware
|
* ~Fix bug causing system to crash when a user removes read permissions from their directory/iris.messages file~
|
||||||
* 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
|
|
||||||
* Add command-line options to README
|
|
||||||
* Made message file slightly more human-readable
|
|
||||||
|
|
||||||
# Completed as of 1.0.6
|
## 1.0.9
|
||||||
|
* ~Stop checking domain on user validation~
|
||||||
|
* ~Fix bug causing color overflow when color tags break.~ Special thanks go out to Japanoise (https://github.com/japanoise) for reporting this bug!
|
||||||
|
|
||||||
|
## 1.0.8
|
||||||
|
* ~Fix bug when UID has been deleted from /etc/passwd, but user''s message file still exists~
|
||||||
|
* ~Add debug mode to Iris~
|
||||||
|
* ~Refactor Iris to make it easier to load test files to run with~
|
||||||
|
|
||||||
|
## 1.0.7
|
||||||
|
* ~Fix "unread count" bug~
|
||||||
|
|
||||||
|
## 1.0.6
|
||||||
* ~Message deletion~
|
* ~Message deletion~
|
||||||
* ~Message editing~
|
* ~Message editing~
|
||||||
* ~Gracefully handle bad message files~
|
* ~Gracefully handle bad message files~
|
||||||
|
@ -97,15 +99,13 @@
|
||||||
* ~Keep replies on edited topics~
|
* ~Keep replies on edited topics~
|
||||||
* ~Add unread topic to overall unread count~
|
* ~Add unread topic to overall unread count~
|
||||||
|
|
||||||
# Completed as of 1.0.8
|
## 1.0.5
|
||||||
* ~Fix "unread count" bug~
|
* ~Make all output WIDTH-aware~
|
||||||
* ~Fix bug when UID has been deleted from /etc/passwd, but user's message file still exists~
|
* ~Add color~
|
||||||
* ~Add debug mode to Iris~
|
* ~Add full message corpus dump for backup/debugging~
|
||||||
* ~Refactor Iris to make it easier to load test files to run with~
|
* ~Add startup enviro health check~
|
||||||
|
* ~Change listing to show last updated timestamp, instead of thread creation timestamp~
|
||||||
# Completed as of 1.0.9
|
* ~Add command-line options to README~
|
||||||
* Stop checking domain on user validation
|
* ~Add documentation for color feature~
|
||||||
* Fix bug causing color overflow when color tags break. Special thanks go out to Japanoise (https://github.com/japanoise) for reporting this bug!
|
* ~Add command-line options to README~
|
||||||
|
* ~Made message file slightly more human-readable~
|
||||||
# Completed as of 1.0.10
|
|
||||||
* Fix bug causing system to crash when a user removes read permissions from their directory/iris.messages file
|
|
||||||
|
|
Loading…
Reference in New Issue