From: Jameson Rollins <jrollins@finestructure.net>
To: Carl Worth <cworth@cworth.org>, david@tethera.net, notmuch@notmuchmail.org
In-Reply-To: <878wajwwth.fsf@yoom.home.cworth.org>
References: <1261114167-sup-8228@lisa>
	<1261141195-5469-1-git-send-email-david@tethera.net>
	<878wajwwth.fsf@yoom.home.cworth.org>
Date: Tue, 23 Feb 2010 16:00:01 -0500
Message-ID: <87wry33bxq.fsf@servo.finestructure.net>
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-=";
	micalg=pgp-sha256; protocol="application/pgp-signature"
Subject: [notmuch] JSON output as default [was: Re: [PATCH] Add an
	"--output=(json|text|)" command-line option...]
Precedence: list

--=-=-=

Hey, Carl.  I mentioned this is an email a while back
(id:87eil4ygar.fsf@servo.finestructure.net), but I want to bring it up
again now that you're looking at the JSON output stuff.  I would like to
make the case for JSON being the one and only output format.  Here's the
arguments:

* JSON is a very well spec'd API
* JSON is a *very* well supported standard (it's basically well
  supported by every language)
* the JSONformat is perfectly suited for notmuch's output
* emacs has a json.el library, so it would not be hard at all to modify
  the notmuch.el to parse json output
* using only one output format would considerably reduce the code base
  in notmuch, keeping things simpler and easier to maintain

I think these are pretty good reason to just move to JSON as *the*
output format.

While I'm on this topic, let me rehash another point I made previously:
If we move to JSON output, it would be *so* sweet to provide means to
filter the output JSON fields.  The "--output" flag could be used to
pick the desired output fields.  For instance, the current "search"
output could be something like:

search --output=thread_id,date,number,author,subject,tags

while the current "show" output could be something like:

search --output=message_id,tags,path,header,body,attachments

This would all make things *much* easier for clients and wrappers.  For
instance, here are just a couple of things that would be made much
easier for wrapper scripts:

* Proper maildir sync ("search --output=message_id,tags,path" ...)

* Purging "delete" tagged messages ("search --output=path" tags:delete)

* Moving/archiving messages based on search results ("search --output=path" ...)

I would personally love to see this.  I think it would make notmuch
cleaner, simpler, and more powerful all at the same time.

Interested in hearing what other's thoughts on this idea are.

jamie.

--=-=-=
Content-Type: application/pgp-signature

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.10 (GNU/Linux)

iQIcBAEBCAAGBQJLhEHSAAoJEO00zqvie6q8sFAP/jpVK6AOhAle5+4MZQqpn1eG
H4Be0N8brsNAeM4o6JvTW7XHdV7O2u/wwGTq2lmoxwF0slcmKjVcWHr7QP7VrvlV
P7iXyfb3A94pjaMldzgtKW5OZ3/a/lE3yPYffBaJ4rcuHcSI/mlugVzy7v4UZ8ep
T0h2kE9B36014YpZklzWpHu1kfj79y0Y2u8ZDRTYWK9mAInLVTsF8zLIYcrfRrDR
wH7WIahtpwye9LeL6oB8Kqi4KfB0MUPvyML80CAu3FiaCd/RA1ij/KUb3JbE2Wf4
D1DAEVnZIxc/WgxGJnoisHM9kSuMAv7pgvxoqlpnxi1cZhL4xGvmlKf7QhgbpyMQ
2JYUvNzRmNndJJGyoMByS2o/KfADkK1ML/TryodYPAI3tkimy+ZL/cN7F1yH1cqp
htUNfJfuTlGEFVpAl/8QMvvRUmTRInKe0MFrr3941FrRc33GZ92qUgUB15v3K6NG
wMg+8pdUPe9r/mY8PyyjWzrqowwIINmexFzzLhNRSG1MnrPoJzk410L3xmnkDKz9
jaIx1bMrHOOa1QMwfC8oou1xSJjqE1Sld7kygUgbnw9c7pdhh3ZdXfS4BXQmJXNz
gXqtHLWBKs7UQ0Ow7zXyqq23+big1QQy1Xe1ViIDBKwTY4momwQ1szu0zeHPE1BL
p32Sfd09W/tE4KNnJKe4
=t2XF
-----END PGP SIGNATURE-----
--=-=-=--