Currently there are no tests to ensure that the utility behaves as expected, particularly in a cross platform way. As noted on the Readme it is unknown if this works on Windows.

This issue will track the work to add the test dependencies and the tests themselves to the project.

On a Windows 10 computer, given a site configuration that has a script like npm run server. Using localhost run mysite throws an error like

PS> localhost run mysite
Error: spawn npm ENOENT
    at Process.ChildProcess._handle.onexit (internal/child_process.js:267:19)
    at onErrorNT (internal/child_process.js:469:16)
    at processTicksAndRejections (internal/process/task_queues.js:84:21) {
  errno: 'ENOENT',
  code: 'ENOENT',
  syscall: 'spawn npm',
  path: 'npm',
  spawnargs: [ 'run', 'index' ]
}

But running npm manually works

PS> npm run index

> [email protected] index C:\Source\localhost-proxy\tests\fixtures\project
> node ./index.js

DEBUG TEST MESSAGE
ERROR TEST MESSAGE
WARN TEST MESSAGE
INFO TEST MESSAGE
LOG TEST MESSAGE

Now that we have some tests, we should probably actually exercise them. This ticket will track the work add some GitHub Actions to run the tests on Windows, Mac and *Nix.

Running localhost --help only shows localhost set and is missing run and tunnel

localhost <command>

Commands:
  localhost set [script]  Set up site config

Options:
  --version  Show version number                                       [boolean]
  --help     Show help                                                 [boolean]

When running localhost --help I get the following output:

PS> localhost --help
index.js [command]

Commands:
  index.js set [script]  Set up site config

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

Note the name of the script is "index.js" not localhost.

This is confusing as a user as surely I should be calling localhost ... not index.js

When starting a local server using the tool, it should proxy the localhost URL (eg. localhost:{port}) to a local domain (eg. my-site.test).

This doesn't expose it to the internet, and is still a local site

Currently the site configuration directory must always be in the users home directory, however there may be cases where users may want to use a non-default location.

Ideally there should be a --sitedir option where a user can pass in the directory for site configuration