Skip to content
This repository has been archived by the owner on Oct 23, 2020. It is now read-only.

How to install this package? #47

Open
Jack-Works opened this issue Apr 17, 2020 · 13 comments
Open

How to install this package? #47

Jack-Works opened this issue Apr 17, 2020 · 13 comments

Comments

@Jack-Works
Copy link

It seems like this package doesn't publish on the npm. When I try to install via git, yarn add git://github.com/nodejs/webcrypto --ignore-scripts -D, it reports error Can't add undefined: invalid package version undefined.

@ljharb
Copy link
Member

ljharb commented Apr 17, 2020

It’s set to private true and lacks a version; i don’t think the prototype is meant to be consumed.

@Jack-Works
Copy link
Author

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

@panva
Copy link
Member

panva commented Apr 17, 2020

This is still just a PoC in progress.

@SmartLayer
Copy link

SmartLayer commented Jun 28, 2020

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

As I filed issue #49 this wouldn't work as a drop-in replacement unless you change the code that uses the library as well, since @trust/webcrypto exposes crypto object directly and yours through .crypto, right?

@tniessen
Copy link
Member

tniessen commented Jun 28, 2020

Sorry, I wasn't particularly active on GitHub recently. This project is a protoype and so far, I have been the only person working on it. Less recently, due to a perceived lack of interest, and the realization that this likely never be a competitive implementation. Oh, and also because some things are really difficult to implement. WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

@Jack-Works
Copy link
Author

WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

This is like the jsdom library. It's useful for testing. ✨ (I use it to test web app)

@SmartLayer
Copy link

SmartLayer commented Jun 29, 2020

Sorry, I wasn't particularly active on GitHub recently. This project is a protoype and so far, I have been the only person working on it. Less recently, due to a perceived lack of interest, and the realization that this likely never be a competitive implementation. Oh, and also because some things are really difficult to implement. WebCrypto doesn't do things the Node.js way, and Node.js doesn't do things the WebCrypto way.

Would you be so kind to rename the repository? The reason is that I came here first because I thought this is the repo of the code that gets installed through 'npm install webcrypto'.

Something like tniessen-WebCrypto would be a good name (or move it away from github.com/nodejs and into a more personal namespace like github.com/tniessen - if that exists). Really appreciated!

@tniessen
Copy link
Member

Would you be so kind to rename the repository?

If we were to publish this, it would likely be under the name @nodejs/webcrypto, so I think the repository name is perfectly reasonable.

@panva
Copy link
Member

panva commented Jun 29, 2020

npm docs webcrypto

this lands you on https://github.com/daviddias/webcrypto#readme, not here. The npm website also has those links displayed.

I agree with @tniessen the repo name is fine.

@ryzokuken
Copy link

Would you be so kind to rename the repository? The reason is that I came here first because I thought this is the repo of the code that gets installed through 'npm install webcrypto'.

For that, you need to check npm, not GitHub.

@SmartLayer
Copy link

SmartLayer commented Jun 30, 2020

If we were to publish this, it would likely be under the name @nodejs/webcrypto, so I think the repository name is perfectly reasonable.

Without going against your decision (it's yours) I am just curious whether or not github.com/nodejs has anything to do with nodejs.org, and if they belong to the same entity, why the future name of this package is not just 'webcrypto' like most other packages using nodejs?

On pavn's note, yes I learned the hard way that one should look at npm website to find the github repo of a npm package. I have been using google for this purpose a few years without realising I was doing it wrong!

@tniessen
Copy link
Member

I am just curious whether or not github.com/nodejs has anything to do with nodejs.org, and if they belong to the same entity

https://github.com/nodejs is the GitHub organization of the Node.js project. The official website of the Node.js project is https://nodejs.org (the code behind the website is in https://github.com/nodejs/nodejs.org). So yes, both the GitHub organization "nodejs" and the domain "nodejs.org" belong to the Node.js project, which is now part of the OpenJS Foundation (formerly Node.js Foundation).

and if they belong to the same entity, why the future name of this package is not just 'webcrypto' like most other packages using nodejs?

For two reasons: First, the name "webcrypto" is already taken, the package already exists. We cannot simply remove a third-party package from npm. Second, unlike modules such as "fs" and "crypto", this is not a part of Node.js core, it is not a built-in module. Instead, it needs to be installed via npm, and we are leaning towards adding the namespace @nodejs to npm packages.

@geeeger
Copy link

geeeger commented Oct 20, 2020

Oh I use it to replace @trust/webcrypto(stop maintenance) in our test environment

try @peculiar/webcrypto ? it might be help

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

7 participants