QR code presenting server address upon startup for better mobile development experience

[tiagostutz]

Related issue: lwsjs/local-web-server#148

[tiagostutz]

Small or Big?

[75lb]

small.. if the user has a 40x20 terminal window open, the large one won't fit..

[tiagostutz]

Currently, the behavior is as follows:

• If the user does not specify the --qr arg, we search for the most suitable private address to use to print the QRCode
• if the user specifies the --qr arg, we use it to print the QRCode

So, it will always present the QRCode. Maybe we should consider some changes in the args because as the default behavior now is to always print the QRCode, the args should be to hide or configure it. I mean, the user could pass a --no-qr arg to hide it and/or change the used interface using --qr-address (or something like) to specify the network interface.

or

we could keep to --qr using a convention like --qr default automatically choose the privately addressed network interface and if the user does not pass the --qr param the QRCode won't be print.

What do you think?

[75lb]

Hi, it should only print the QR code if the user asked for it.

Regular behaviour (no QR):

$ ws

Regular behaviour plus print a QR code with the default network interface:

$ ws --qr

or with a specific interface:

$ ws --qr en1

Does that sound ok?

[tiagostutz]

I tried this at first, but as the —qr is a String param, if there is no arg for it, it will not come in the config object and hence the user won’t be able to pass only —qr. This way, he/she will have to know the network interface...

Maybe —qr auto to leave the system automatically choose the network interface with private IP address could be an option.

Or is there a way to use —qr as String and Boolean flag at the same time that I’m missing?

[75lb]

if --qr was specified, you should receive qr: null in the config object (you can can interpret null to mean "use the default interface").

If the qr property does not exist at all on the config object, then --qr was not set. Clear?

[75lb]

The documentation for the type property in the option definition specifies that null is returned, if the option was set but no value was passed.. if this is not the case let me know.

[tiagostutz]

That's correct. I was making a wrong verification here.
Sorry about that.
Thanks!