Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

Clarify what this repo is and its package name #112

Closed
vmx opened this issue Jan 29, 2018 · 14 comments
Closed

Clarify what this repo is and its package name #112

vmx opened this issue Jan 29, 2018 · 14 comments
Assignees

Comments

@vmx
Copy link
Member

vmx commented Jan 29, 2018

This repo got renamed from js-ipld-resolver to just js-ipld. What should the description say?

The GitHub description is: "JavaScript implementation of the IPLDService"
The package.json description is: "IPLD Resolver Implementation in JavaScript"
The Readme description is: "The JavaScript implementation of the IPLD, InterPlanetary Linked-Data"

I guess all should be the same.

This repo currently is published as ipld-resolver. @diasdavid mentions in #110 (comment) that this package should be deprecated an republished as just ipld.

Though the ipld npm package currently points to https://github.com/diasdavid/js-ipld which currently redirects to https://github.com/ipld/js-ipld-dag-cbor.

And then there's also the ipfs-ipld npm package which points to https://github.com/ipfs/js-ipfs-ipld which redirects to https://github.com/ipld/js-ipld.

@vmx
Copy link
Member Author

vmx commented Jan 29, 2018

For the whole npm business I propose:

  • The ipld package will be what is currently in this repository. Just override whatever is currently there if that's possible. This might break a lot of things.
  • Deprecate the ipld-resolver package and add a warning that it is now named ipld
  • Deprecate the ipfs-ipld package and add a warning that it is now named ipld

@vmx
Copy link
Member Author

vmx commented Jan 29, 2018

In regards to the description: I tried to find out what an "IPLD Service" is. It think the name would match this repository quite well, but I'm not sure if it already has some other meaning.

I'm not sure if naming a concept (IPLD) and the implementation the same is a good idea. That would be the case with "The JavaScript implementation of the IPLD". If we go with "IPLD Service" one could say "The JavaScript IPLD Service is an implementation of IPLD". And if you have discussion about the implementation, you can always say "IPLD Service" to make sure you mean the implementation.

@vmx
Copy link
Member Author

vmx commented Jan 29, 2018

As I tried to nail all this down, I looked at the Go side of things. There the corresponding repository https://github.com/ipfs/go-ipld is deprecated. Isn't there an equivalent? Is go-ipfs using the IPLD formats directly without another layer in between?

@mkg20001
Copy link

mkg20001 commented Feb 3, 2018

I think "IPLD Api" would be a good name because without bitswap the IPLD module isn't really a service

@daviddias
Copy link
Member

Oh wow, what a long turn -- https://www.npmjs.com/package/ipld --. @dignifiedquire can you give me and @vmx perms to that package?

@vmx that package was created when the world thought that IPLD was CBOR.. (circa 2016)

@dignifiedquire
Copy link
Member

@vmx that package was created when the world thought that IPLD was CBOR.. (circa 2016)

ahh simpler times :)

@daviddias
Copy link
Member

@vmx, from @dignifiedquire:

> npm owner ls ipld
daviddias <[email protected]>
vmx <[email protected]>

@vmx
Copy link
Member Author

vmx commented Feb 22, 2018

So we publish this one as version 1.0.0 under the new name?

@daviddias
Copy link
Member

We are still in the below 1.0.0 mode for IPFS modules until the whole IPFS protocol becomes 1.0.0 itself.

@vmx
Copy link
Member Author

vmx commented Feb 22, 2018

Yes for sure, but replacing an existing package sounds to me like a mega-breaking change. Anyway, I'll let you sort this out, you know the JS ecosystem better than me.

@daviddias
Copy link
Member

@vmx js-ipld never got used and it doesn't really work for anything right now. The 286 Installs are all probably from CIs going through the registry :)

@daviddias daviddias added the status/ready Ready to be worked label Mar 19, 2018
@daviddias
Copy link
Member

@vmx I feel that this is now clear to everyone, closing but reopen if you feel a different way.

@daviddias daviddias removed the status/ready Ready to be worked label Mar 21, 2018
@vmx
Copy link
Member Author

vmx commented Mar 26, 2018

@diasdavid Parts of the original issue is still not resolved. The Github description, the README and the package.json should have the same description. Currently they all say something different.

@vmx vmx reopened this Mar 26, 2018
@daviddias
Copy link
Member

All the same now \o/ :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants