search

wking-io / elm-live

⚡ A flexible dev server for Elm. Live reload included.
https://elm-live.com
MIT License
1.05k stars 61 forks source link

Documentation mistake on proxy flag names #226

Open tgelu opened 4 years ago

tgelu commented 4 years ago

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 commented 4 years ago

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

tgelu commented 4 years ago

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

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

matheus23 commented 3 years ago

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!