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

Time for deprecation?... #319

Open
neonexus opened this issue Dec 20, 2023 · 6 comments
Open

Time for deprecation?... #319

neonexus opened this issue Dec 20, 2023 · 6 comments

Comments

@neonexus
Copy link

neonexus commented Dec 20, 2023

While myself (and I'm sure countless others) appreciate what this package did for us in the past; with Ngrok's new official NPM package (which clocks in less than a MB after secondary installs), I'm left asking the question, is it time to retire / deprecate this package?

It seems like a LOT of work moving forward otherwise.

@neonexus
Copy link
Author

The new, official (binary-free) package: @ngrok/ngrok

@scr4bble
Copy link

scr4bble commented Jan 4, 2024

It seems like in the official package it is not possible to use the ngrok from command line.
So for example not a replacement for us :) yet

node_modules/@ngrok/ngrok/bin/ngrok

@neonexus
Copy link
Author

neonexus commented Jan 5, 2024

It seems like in the official package it is not possible to use the ngrok from command line. So for example not a replacement for us :) yet

node_modules/@ngrok/ngrok/bin/ngrok

@scr4bble Why is running Ngrok from the command line a requirement? The whole point of a package like this is to integrate Ngrok into your Node.js app.

Here's a working example built for Sails.js apps:
https://github.com/neonexus/sails-react-bootstrap-webpack/blob/release/ngrok.js

Using that script, I can just run npm run ngrok, and it will boot my application, build assets, and connect Ngrok.

@johnrobertcobbold
Copy link

@scr4bble Why is running Ngrok from the command line a requirement? The whole point of a package like this is to integrate Ngrok into your Node.js app.

Not a requirement for everyone but a feature that some people might need, including us as it allows us to automate a few things and make use of the local web interface amongst others - see ngrok/ngrok-javascript#62

@scr4bble
Copy link

Author

You kind of explained it inside your reply. The file you linked to is exactly the thing we don't need when being able to just run the "binary".

Our yarn ngrok command runs a simple two liner shell script (and even this shell script is not necessary if you don't mind slightly longer command inside package.json):

source "${SCRIPT_DIR}/../.env"
../node_modules/ngrok/bin/ngrok http --inspect=false ${PORT}

That feels much easier than being forced to write the javascript/typescript code to integrate ngrok into the app.

@bentacos
Copy link

It seems like in the official package it is not possible to use the ngrok from command line. So for example not a replacement for us :) yet
node_modules/@ngrok/ngrok/bin/ngrok

@scr4bble Why is running Ngrok from the command line a requirement? The whole point of a package like this is to integrate Ngrok into your Node.js app.

Here's a working example built for Sails.js apps: https://github.com/neonexus/sails-react-bootstrap-webpack/blob/release/ngrok.js

Using that script, I can just run npm run ngrok, and it will boot my application, build assets, and connect Ngrok.

how about just stfu if you don't use the command line

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

No branches or pull requests

4 participants