TODO: Add some new items about improving the test suite.
[notmuch] / TODO
1 Fix the things that are causing the most pain to new users
2 ----------------------------------------------------------
3 1. A new import is tagging all messages as "inbox" -- total pain
4
5 2. Allow an easy way to get tags from directory names (if the user has them)
6
7 Emacs interface (notmuch.el)
8 ----------------------------
9 Enhance '+' and '-' in the search view to operate on an entire region
10 if set.
11
12 Fix '*' to work by simply calling '+' or '-' on a region consisting of
13 the entire buffer.
14
15 Add a global keybinding table for notmuch, and then view-specific
16 tables that add to it.
17         
18 Add a '|' binding from the search view.
19
20 Add support for choosing from one of the user's configured email
21 addresses for the From line.
22
23 Make 'notmuch-show-pipe-message have a private history.
24
25 Add support for a delete keybinding that adds a "deleted" tag to the
26 current message/thread and make searches not return deleted messages
27 by default, (unless the user asks explicitly for deleted messags in
28 the search query).
29
30 Add support to "mute" a thread (add a "muted" tag and then don't
31 display threads in searches by default where any message of the thread
32 has the "muted" tag).
33
34 Fix i-search to open up invisible citations as necessary.
35
36 Emacs saved-search interface
37 ----------------------------
38 Here's a proposal Carl wrote (id:87einafy4u.fsf@yoom.home.cworth.org):
39
40   So what I'm imagining for the default notmuch view is something like
41   this:
42
43           Welcome to notmuch.
44
45               Notmuch search: _________________________________________
46
47           Saved searches:
48
49               55,342      All messages
50                   22      Inbox
51
52           Recent searches:
53
54                    1      from:"someone special" and tag:unread
55                   34      tag:notmuch and tag:todo
56
57           Click (or press Enter) on any search to see the results.
58           Right-click (or press Space) on any recent search to save it.
59
60   So the "saved searches" portion of the view is basically just what
61   notmuch-folder displays now. Above that there's an obvious place to
62   start a new search, (in a slightly more "web-browser-like" way than the
63   typical mini-buffer approach).
64
65   All recent searches appear in the list at the bottom automatically, and
66   there's the documented mechanism for saving a search, (giving it a name
67   and having it appear above).
68
69 Portability
70 -----------
71 Fix configure script to test each compiler warning we want to use.
72
73 Completion
74 ----------
75 Fix bash completion to complete multiple search options (both --first
76 and *then* --max-threads), and also complete value for --sort=
77 (oldest-first or newest-first).
78
79 notmuch command-line tool
80 -------------------------
81 Fix the --format=json option to not imply --entire-thread.
82
83 Implement "notmuch search --exclude-threads=<search-terms>" to allow
84 for excluding muted threads, (and any other negative, thread-based
85 filtering that the user wants to do).
86
87 Fix "notmuch show" so that the UI doesn't fail to show a thread that
88 is visible in a search buffer, but happens to no longer match the
89 current search. (Perhaps add a --matching=<secondary-search-terms>
90 option (or similar) to "notmuch show".) For now, this is being worked
91 around in the emacs interface by noticing that "notmuch show" returns
92 nothing and re-rerunning the command without the extra arguments.
93
94 Teach "notmuch search" to return many different kinds of results. Some
95 ideas:
96
97         notmuch search --output=threads # Default if no --output is given
98         notmuch search --output=messages
99         notmuch search --output=tags
100         notmuch search --output=addresses
101         notmuch search --output=terms
102
103 Add a "--format" option to "notmuch search", (something printf-like
104 for selecting what gets printed).
105
106 Add a "--count-only" (or so?) option to "notmuch search" for returning
107 the count of search results.
108
109 Give "notmuch restore" some progress indicator.
110
111 Fix "notmuch restore" to operate in a single pass much like "notmuch
112 dump" does, rather than doing N searches into the database, each
113 matching 1/N messages.
114
115 Add a "-f <filename>" option to select an alternate configuration
116 file.
117
118 Allow configuration for filename patterns that should be ignored when
119 indexing.
120
121 notmuch library
122 ---------------
123 Provide a sane syntax for date ranges. First, we don't want to require
124 both endpoints to be specified. For example it would be nice to be
125 able to say things like "since:2009-01-1" or "until:2009-01-1" and
126 have the other endpoint be implicit. Second we'd like to support
127 relative specifications of time such as "since:'2 months ago'". To do
128 any of this we're probably going to need to break down an write our
129 own parser for the query string rather than using Xapian's QueryParser
130 class.
131
132 Make failure to read a file (such as a permissions problem) a warning
133 rather than an error (should be similar to the existing warning for a
134 non-mail file).
135
136 Actually compile and install a libnotmuch shared library.
137
138 Fix to use the *last* Message-ID header if multiple such headers are
139 encountered, (I noticed this is one thing that kept me from seeing the
140 same message-ID values as sup).
141
142 Add support for the user to specify custom headers to be indexed.
143
144 Add support for configuring "virtual tags" which are a tuple of
145 (tag-name, search-specification). The database is responsible for
146 ensuring that the virtual tag is always consistent.
147
148 Indicate to the user if two files with the same message ID have
149 content that is actually different in some interesting way. Perhaps
150 notmuch initially sees all changes as interesting, and quickly learns
151 from the user which changes are not interesting (such as the very
152 common mailing-list footer).
153
154 Fix notmuch_query_count_messages to share code with
155 notmuch_query_search_messages rather than duplicating code. (And
156 consider renaming it as well.)
157
158 Provide a mechanism for doing automatic address completion based on
159 notmuch searches. Here was one proposal made in IRC:
160
161         <cworth> I guess all it would really have to be would be a way
162                  to configure a series of searches to try in turn,
163                  (presenting ambiguities at a given single level, and
164                  advancing to the next level only if one level
165                  returned no matches).
166         <cworth> So then I might have a series that looks like this:
167         <cworth> notmuch search --output=address_from tag:address_book_alias
168         <cworth> notmuch search --output=address_to tag:sent
169         <cworth> notmuch search --output=address_from
170         <cworth> I think I might like that quite a bit.
171         <cworth> And then we have a story for an address book for
172                  non-emacs users.
173
174 Provide a ~me Xapian synonym for all of the user's configured email
175 addresses.
176
177 Test suite
178 ----------
179 Achieve 100% test coverage with the test suite.
180
181 Modularize test suite (to be able to run individual tests).
182
183 Summarize test results at the end.
184
185 Fix the insane quoting nightmare of the test suite, (and once we do
186 that we can actually test the implicit-phrase search feature such as
187 "notmuch search 'body search (phrase)'"
188
189 General
190 -------
191 Audit everything for dealing with out-of-memory (and drop xutil.c).
192
193 Investigate why the notmuch database is slightly larger than the sup
194 database for the same corpus of email.