aboutsummaryrefslogtreecommitdiffstats
path: root/commands/account/search.go
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2024-10-12 00:21:46 +0200
committerRobin Jarry <robin@jarry.cc>2024-10-23 10:22:51 +0200
commitd0484b153aa5fa80c415f4025aef493eba167e12 (patch)
tree663b4d52d6f7e070477963346e3e3699eca8c384 /commands/account/search.go
parent26033eaecfe6733b2f911dea283433df11773256 (diff)
downloadaerc-d0484b153aa5fa80c415f4025aef493eba167e12.tar.gz
completion: add command option descriptions
Add `desc:""` struct field tags in all command arguments where it makes sense. The description values will be returned along with completion choices. Implements: https://todo.sr.ht/~rjarry/aerc/271 Signed-off-by: Robin Jarry <robin@jarry.cc> Tested-by: Bojan Gabric <bojan@bojangabric.com> Tested-by: Jason Cox <me@jasoncarloscox.com> Acked-by: Tim Culverhouse <tim@timculverhouse.com>
Diffstat (limited to 'commands/account/search.go')
-rw-r--r--commands/account/search.go26
1 files changed, 13 insertions, 13 deletions
diff --git a/commands/account/search.go b/commands/account/search.go
index 5dde3322..f64bcf91 100644
--- a/commands/account/search.go
+++ b/commands/account/search.go
@@ -19,20 +19,20 @@ import (
)
type SearchFilter struct {
- Read bool `opt:"-r" action:"ParseRead"`
- Unread bool `opt:"-u" action:"ParseUnread"`
- Body bool `opt:"-b"`
- All bool `opt:"-a"`
- UseExtension bool `opt:"-e"`
- Headers textproto.MIMEHeader `opt:"-H" action:"ParseHeader" metavar:"<header>:<value>"`
- WithFlags models.Flags `opt:"-x" action:"ParseFlag" complete:"CompleteFlag"`
- WithoutFlags models.Flags `opt:"-X" action:"ParseNotFlag" complete:"CompleteFlag"`
- To []string `opt:"-t" action:"ParseTo" complete:"CompleteAddress"`
- From []string `opt:"-f" action:"ParseFrom" complete:"CompleteAddress"`
- Cc []string `opt:"-c" action:"ParseCc" complete:"CompleteAddress"`
- StartDate time.Time `opt:"-d" action:"ParseDate" complete:"CompleteDate"`
+ Read bool `opt:"-r" action:"ParseRead" desc:"Search for read messages."`
+ Unread bool `opt:"-u" action:"ParseUnread" desc:"Search for unread messages."`
+ Body bool `opt:"-b" desc:"Search in the body of the messages."`
+ All bool `opt:"-a" desc:"Search in the entire text of the messages."`
+ UseExtension bool `opt:"-e" desc:"Use custom search backend extension."`
+ Headers textproto.MIMEHeader `opt:"-H" action:"ParseHeader" metavar:"<header>:<value>" desc:"Search for messages with the specified header."`
+ WithFlags models.Flags `opt:"-x" action:"ParseFlag" complete:"CompleteFlag" desc:"Search messages with specified flag."`
+ WithoutFlags models.Flags `opt:"-X" action:"ParseNotFlag" complete:"CompleteFlag" desc:"Search messages without specified flag."`
+ To []string `opt:"-t" action:"ParseTo" complete:"CompleteAddress" desc:"Search for messages To:<address>."`
+ From []string `opt:"-f" action:"ParseFrom" complete:"CompleteAddress" desc:"Search for messages From:<address>."`
+ Cc []string `opt:"-c" action:"ParseCc" complete:"CompleteAddress" desc:"Search for messages Cc:<address>."`
+ StartDate time.Time `opt:"-d" action:"ParseDate" complete:"CompleteDate" desc:"Search for messages within a particular date range."`
EndDate time.Time
- Terms string `opt:"..." required:"false" complete:"CompleteTerms"`
+ Terms string `opt:"..." required:"false" complete:"CompleteTerms" desc:"Search term."`
}
func init() {