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

TS Bindings: check if has NPM, throw useful error + instructions, and fix broken links to old soroban docs #1511

Closed
chadoh opened this issue Jul 31, 2024 · 4 comments
Assignees
Labels
bug Something isn't working

Comments

@chadoh
Copy link
Contributor

chadoh commented Jul 31, 2024

Reported by a user:

After running bindings typescript it returns an error, "program not found". And while it does generate some typescript files, the node modules folder as well as the dish folder is missing.

This happens because right now we assume that you have Node/NPM, rather than verifying and erroring with a more useful error message.

Let's check if Node & NPM are installed and, if not, error with this explanation:

This command generates an NPM package for use with a NodeJS codebase. You need Node/NPM to build the generated package, and you'll also need it to import and use it. There are many ways to install Node; a popular way is nvm, Node Version Manager: https://github.com/nvm-sh/nvm

@chadoh chadoh added the bug Something isn't working label Jul 31, 2024
@chadoh chadoh added this to DevX Jul 31, 2024
@github-project-automation github-project-automation bot moved this to Backlog (Not Ready) in DevX Jul 31, 2024
@leighmcculloch
Copy link
Member

leighmcculloch commented Jul 31, 2024

Suggested tweaks to the explanation to remove the you's:

This command generates an NPM package for use with a NodeJS codebase. Node/NPM is required to build the generated package, import it, and use it. See https://nodejs.org/en/download to install Node/NPM.

The node website shows a variety of install options and by default shows the nvm instructions.

@janewang janewang moved this from Backlog (Not Ready) to Todo (Ready for Dev) in DevX Aug 6, 2024
@janewang janewang changed the title TS Bindings: check if has NPM, throw useful error + instructions TS Bindings: check if has NPM, throw useful error + instructions, and fix broken links to old soroban docs Aug 6, 2024
@janewang
Copy link
Contributor

janewang commented Aug 6, 2024

For cleaning up and add checks and errors, could we also clean up the old links to soroban-docs. We have merged all docs under stellar docs.

@janewang
Copy link
Contributor

janewang commented Aug 6, 2024

we are not going to use npm anymore, closing

@janewang janewang closed this as completed Aug 6, 2024
@github-project-automation github-project-automation bot moved this from Todo (Ready for Dev) to Done in DevX Aug 6, 2024
@janewang janewang reopened this Aug 6, 2024
@janewang janewang closed this as not planned Won't fix, can't repro, duplicate, stale Aug 6, 2024
@janewang janewang reopened this Aug 6, 2024
@janewang janewang closed this as not planned Won't fix, can't repro, duplicate, stale Aug 6, 2024
@leighmcculloch
Copy link
Member

This was closed in favor of:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Done
Development

No branches or pull requests

3 participants