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

Documentation mistake on proxy flag names #226

Open
tgelu opened this issue Apr 10, 2020 · 3 comments
Open

Documentation mistake on proxy flag names #226

tgelu opened this issue Apr 10, 2020 · 3 comments

Comments

@tgelu
Copy link

tgelu commented Apr 10, 2020

Both the README.md and https://www.elm-live.com/ mention two flags --proxy-host and --proxy-prefix but the elm-live --help refers to them in camel case --proxyHost and --proxyPrefix. It appears that the camel case is the correct name which means the documentation is mistaken.

Took me a long while to notice this :(

@wking-io
Copy link
Owner

Thank you for pointing this out! I will get this updated 👌

@tgelu
Copy link
Author

tgelu commented Apr 15, 2020

Thank you for pointing this out! I will get this updated 👌

This package is an excellent tool btw. Thank you for maintaining it! 🤓

@matheus23
Copy link

Pretty sure OP had this issue because of an API change between versions.
I had a similar issue:
I was running elm-live version 4.0.2 (pnpx elm-live --version > 4.0.2), but I looked at the help text via elm-live --help, which documented --proxyHost, but I that's an old help text for an older version: elm-live --version > 3.4.1.

Running pnpx elm-live --help gives the correct help texts.

For anyone wondering, as far as I understand, the README and documentation page are just documenting the most up-to-date elm-live version correctly (--proxy-host and --proxy-prefix). If you have an issue configuring proxies, try upgrading your elm-live version.

@wking-io I'd suggest crashing with an error when unexpected configuration options are passed to elm-live, that would've probably saved me and @tgelu lots of time :)

And to reiterate @tgelu's sentiment: elm-live is amazing indeed. I'm using it almost every day!

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

3 participants