Document platform requirements about js-git

[creationix]

Good idea.

So for a bare local repo, all that's needed is the git-db interface. Inflate and Deflate are internal implementation details for that. Network communication is a little trickier. For clone/fetch/ls-remote the platform needs to provide tcp, http, and/or ssh interfaces (depending on which protocols you want to support).

If you want to use the built-in fs-db library, then you do need inflate/deflate/sha1 as well as an fs instance.

If you want to have a working directory, you need to provide an fs instance as part of the git-db interface. You don't have to use the fs-db adapter library. You could do this with only indexdb by emulating the fs on top of the indexdb system, but using indexdb directly for the git-db implementation.

[maks]

@creationix yes but I was thinking about the "platform" package and what implementations of it need to provide.

But now that I think about I have confused the low-level with higher level requirements!

So with https://github.com/creationix/js-git-node-platform it provides node-based implementations of: sha1, inflate/deflate, fs, http, ssh, etc

And then a (imaginary) js-git-node-lib would provide object-db, working-dir, index-db, ls-remote, fetch, push, etc on top of what the platform module provides. The rough equivalent of cgit "plumping" cmds.

Does that makes sense?

[creationix]

I don't there would be such a high-level library, and if there was, it would be simply:

require('js-git/lib/platform.js')(require('js-git-node-platform'));
module.exports = require('js-git');

Assuming that js-git eventually exports a central thing.

All the high-level APIs will either be in js-git itself or in js-git addon modules, both which would be platform independent I think.

[maks]

@creationix Yes you're right as usual! :-)
I had an even harder think about it and yes i can see that a platform just needs to expose the git-db interface for bare repo access.
For any kind of remote ops, it needs to expose at least 1 transport protocol (http, ssh, etc).
And then to support working dirs it needs to expose a fs interface.

But what about the index, do we need a seperate interface for it? or is it just something that client code of js-git will just handle itself?

[maks]

As discussed on irc, the index interface should have: add/remove/read/list functions.

[creationix]

I documented this in the main README at the js-git repo.

We'll be adding more as we implement the other milestones.