Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explain why the typescript dependency? #294

Closed
zachlysobey opened this issue Jun 21, 2019 · 4 comments
Closed

Explain why the typescript dependency? #294

zachlysobey opened this issue Jun 21, 2019 · 4 comments
Assignees

Comments

@zachlysobey
Copy link

@zachlysobey zachlysobey commented Jun 21, 2019

This is a nitpick for sure, but I think there is a superfluous typescript dependency?

There doesn't seem to be any .ts files in the project, no other reference to typescript.

https://github.com/blockstack/animal-kingdom/blob/master/package.json#L12

If this was added in error, probably makes sense to do:

npm uninstall --save typescript

That should get rid of package.json AND package-lock.json references.

@moxiegirl

This comment has been minimized.

Copy link
Contributor

@moxiegirl moxiegirl commented Jun 21, 2019

Hi @zachlysobey The blockstack.js lib is written in typescript. We recently did an overhaul of that package to determine the minimum required set of packages.

@zachlysobey

This comment has been minimized.

Copy link
Author

@zachlysobey zachlysobey commented Jun 21, 2019

@moxiegirl sounds like it is there for a reason then? But I'm still confused.

I see that typescript is a (build-time) dev-dependency of the blockstack.js project. But that shouldn't mean that you would need to include that package in consumers of blockstack.js. And certainly not as a regular run-time dependency. If typescript really is required, than that would indicate to me that something really really weird is going on :)

@Sahana-Srinivasan

This comment has been minimized.

Copy link
Contributor

@Sahana-Srinivasan Sahana-Srinivasan commented Jun 21, 2019

Hi @zachlysobey You're right; nothing's written in typescript in Animal Kingdom and it's not needed. I just put it in there because a lot of folks in Animal Kingdom are new users and we don't want to confuse them with a lot of peer dependency warnings, in case someone doesn't know they can be ignored (having typescript in there clears about a half-dozen).

@moxiegirl

This comment has been minimized.

Copy link
Contributor

@moxiegirl moxiegirl commented Jun 24, 2019

@zachlysobey Thank you for this issue. I'm going to go ahead and change the title slightly. I'll add a small explanation to the docs about why we do this.

@moxiegirl moxiegirl changed the title Why the typescript dependency? Explain why the typescript dependency? Jun 24, 2019
@moxiegirl moxiegirl self-assigned this Jun 24, 2019
@moxiegirl moxiegirl transferred this issue from blockstack/animal-kingdom Jul 9, 2019
@jeffdomke jeffdomke closed this Feb 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.