@ninhache/probe 0.5.0 → 0.7.0

package/README.md

@@ -41,13 +41,16 @@ Want `make check` too? See [Makefile](#makefile): it is optional.
 | --------------------------------------------------------- | ---------------------------------------------------------------------- |
 | `probe init`                                              | Create `.probe/` and the `.gitignore` entries                          |
 | `probe add <name> -p <port> [--host] [--path] [--expect]` | Add a service (`--timeout <seconds>` gives it its own timeout)         |
-| `probe rm <name>`                                         | Remove a service                                                       |
+| `probe rm <name> [--yes]`                                 | Remove a service                                                       |
 | `probe ls`                                                | List services                                                          |
 | `probe check [name...] [--json] [--timeout <seconds>]`    | Check all services, or the named ones                                  |
 | `probe wait [name...] [--json] [--timeout <seconds>]`     | Check again until every service is up, or give up after the timeout    |
+| `probe open <name>`                                       | Open the URL of a service in the browser                               |
+| `probe curl <name>`                                       | Print the curl command that requests a service                         |
 | `probe status`                                            | CLI version, pending migration, Makefile block state, available update |
 | `probe sync`                                              | Add or regenerate the Makefile block (optional)                        |
 | `probe migrate`                                           | Migrate `.probe/config.yml` to the current schema                      |
+| `probe completion <zsh\|bash\|fish>`                      | Print the shell completion script                                      |
 
 Exit codes: `0` all up, `1` a service is down, `2` usage or config error.
 
@@ -61,7 +64,31 @@ longest one. Unlike `check --timeout`, which is the time given to each service,
 wait; each check inside it still gets 3 s, or the service's own `timeout`. Progress goes to stderr, the final
 report to stdout; exit code `1` names the services still down.
 
-`probe` works from any sub-directory: it walks up to the nearest `.probe/`.
+`probe add` alone, on a terminal, asks for the name, the port, the path and the expected status, one at a time:
+Enter alone keeps the default, Ctrl+C adds nothing. Off a terminal it needs its arguments, as before.
+
+`probe rm` is the one command that deletes something. On a terminal it asks first, with "No" selected: `--yes`
+(`-y`) skips the question. Off a terminal, in a script or in CI, it removes at once, as before.
+
+`probe open` uses `open` on macOS and `xdg-open` elsewhere. Without it, the URL is printed and the exit code is
+`1`. `probe curl api` prints a command to copy, or to run: `probe curl api | sh`.
+
+`probe` works from any sub-directory: it walks up to the nearest `.probe/`. When there is none, on a terminal,
+it offers to create it where you are, then runs your command. Off a terminal it stops with exit code `2`.
+
+## Completion
+
+Tab completes the commands, their options and the names of your services (`probe check a<Tab>`).
+
+```sh
+eval "$(probe completion zsh)"     # in ~/.zshrc, after compinit
+eval "$(probe completion bash)"    # in ~/.bashrc (macOS: ~/.bash_profile)
+probe completion fish | source     # in ~/.config/fish/config.fish
+```
+
+In zsh you can also save it once instead: `probe completion zsh > ~/.zfunc/_probe`, with `~/.zfunc` in your
+`fpath`; in fish, `probe completion fish > ~/.config/fish/completions/probe.fish`. It works with the bash 3.2
+of macOS.
 
 ## Dashboard
 
@@ -142,12 +169,16 @@ outside the block is yours and is never touched. Without a block, no command cre
 Once the block is there, `probe add` and `probe rm` keep it up to date. Commit the `Makefile` and
 `.probe/lock.yml`.
 
-Targets: `help`, `check`, `status` and one `check-<name>` per service. The block uses `probe` when it is in
+Targets: `help`, `check`, `status`, `probe` (opens the [dashboard](#dashboard)) and one `check-<name>` per
+service. The block uses `probe` when it is in
 your `PATH`, else `npx -y @ninhache/probe@latest`. It works with GNU Make 3.81 (the macOS default).
 
 Edited the block by hand? `probe status` says so and `probe add` / `probe rm` leave it alone. `probe sync`
 restores it.
 
+A newer `probe` can add targets to the block: `make probe` came with 0.6.0. A block written before that is
+reported as `outdated` by `probe status`. Run `probe sync` once to get the new targets.
+
 ## Migrations
 
 `config.yml` carries a `schemaVersion`. When a newer `probe` needs a newer schema, the first command you run:

package/dist/{chunk-4VXL4OTD.js → chunk-YTTYVEYF.js}

@@ -27,6 +27,7 @@ var REGISTRY_TIMEOUT_MS = 5e3;
 var UPDATE_CHECK_TTL_MS = 24 * 60 * 60 * 1e3;
 var UPDATE_CACHE_FILE = "latest.json";
 var REFRESH_COMMAND = "__refresh-update-cache";
+var COMPLETE_COMMAND = "__complete";
 var EXIT_DOWN = 1;
 var EXIT_ERROR = 2;
 
@@ -164,6 +165,12 @@ function targetUrl(service) {
   const host = bareIpv6 ? `[${service.host}]` : service.host;
   return `http://${host}:${service.port}${service.path}`;
 }
+var shellQuoted = (text) => `'${text.replaceAll("'", "'\\''")}'`;
+function curlCommand(service) {
+  const follow = expectsRedirect(service.expect) ? "" : " -L";
+  const seconds = service.timeout ?? DEFAULT_TIMEOUT_SECONDS;
+  return `curl -i${follow} --max-time ${seconds} ${shellQuoted(targetUrl(service))}`;
+}
 function isExpected(expect, status) {
   if (expect === void 0) return status >= 200 && status < 300;
   return Array.isArray(expect) ? expect.includes(status) : expect === status;
@@ -349,6 +356,7 @@ export {
   UPDATE_CHECK_TTL_MS,
   UPDATE_CACHE_FILE,
   REFRESH_COMMAND,
+  COMPLETE_COMMAND,
   EXIT_DOWN,
   EXIT_ERROR,
   ProbeError,
@@ -357,6 +365,8 @@ export {
   isInteractive,
   truncate,
   stripStyles,
+  targetUrl,
+  curlCommand,
   runChecks,
   formatCheckResults,
   formatServices