WIP: ls

[rasmuserik]

Implementation of js-ipfs ls (#927)

Tasks:

• add ls command
• implement initial working version
• add -v / --headers support
• indent/present results similar to the output of the go implementation
• use ipfs-unixfs to check filetype, instead of just checking raw data
• tests
• move implementation into core, and add http-api
• move the tests from https://github.com/ipfs/js-ipfs-api/blob/master/test/ls.spec.js to https://github.com/ipfs/interface-ipfs-core
• write ls spec on https://github.com/ipfs/interface-ipfs-core/blob/master/src/files.js
• make sure that ls tests pass in both js-ipfs-api and js-ipfs

This implements a basic working version of js-ipfs ls, supporting listing of directories, with similar output as go-ipfs ls.

Notice: the progress will be slow, as I only have a few hours per week for this kind of projects.

[daviddias]

Hi @rasmuserik, great head start :)

I see that you implemented this feature only in cli and not in core + http-api. We want to have it implemented in core and then have http-api and cli consuming that core api (see other files commands)

Also, now that ls is becoming a thing, we want:

• move the tests from https://github.com/ipfs/js-ipfs-api/blob/master/test/ls.spec.js to https://github.com/ipfs/interface-ipfs-core
• write ls spec on https://github.com/ipfs/interface-ipfs-core/blob/master/src/files.js
• make sure that ls tests pass in both js-ipfs-api and js-ipfs

Sounds like something you want to tackle too? Thank you!

[daviddias]

We are not using destructuring just yet. Could you change it?

Why? We review the JS best practices every quarter or so and commit to a set of things, this helps us agree on codestyle and move forward faster :)

[rasmuserik]

Yes, that is changed now. Is there a place where the agreed code style is documented?
(The destructuring is not mentioned js-project-guidelines.md, nor in the standard code style)

[rasmuserik]

I've added the tasks you mentioned to the list, and will look into it, when I have some time.

[daviddias]

Hi @rasmuserik how are things going? Any hopes of getting ls to see the light of day? Can we help?

[rasmuserik]

Hi @diasdavid, I am busy with other projects at the moment, so unfortunately I do not have time to look into it for the time being (and no recent progress) ‐ it is on my backlog, but very very far down :(
It is also fine with me if somebody else takes over this issue (either build on the code I made here, or discard it and build it from scratch).

[rasmuserik]

Closing this pull-request, as I am too busy with other projects.

[daviddias]

Let's keep it open and just signal that is open for contributions :)

[pgte]

Being continued in #1073