@ninhache/probe 0.6.0 → 0.8.0

package/README.md

@@ -41,7 +41,7 @@ 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    |
@@ -64,10 +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 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.
+
+On a terminal, `probe init` and `probe add` alone first show the services they find in the project, as a list to
+tick. Nothing is ticked at first, and nothing is written unless you tick it. They look at:
+
+- the compose file (`compose.yaml`, `compose.yml`, `docker-compose.yaml` or `docker-compose.yml`) and its
+  `override` file: the ports a service publishes (`"8080:80"`), under the name of the service. A variable in a
+  port takes its value from `.env`. Https, mail, database, cache and broker ports are left out.
+- `.env` and `.env.local`: `PORT`, and the `*_URL` that point to `http://localhost`. Only the host, the port and
+  the path are kept: no other value is kept, shown or written.
+- `package.json`: the port a script names (`--port 4000`), or the usual one of its dev server (vite, next, nuxt,
+  astro, angular).
+- the local ports 3000, 3001, 4200, 4321, 5173, 8000 and 8080, when an HTTP server answers there (one `GET /`
+  each, redirects not followed).
+  `PROBE_DETECT_PORTS=4000,4001` tries other ports, `PROBE_DETECT_PORTS=` none.
+
+`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/`.
+`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
 

package/dist/{chunk-YTTYVEYF.js → chunk-Z4F2X5IS.js}

@@ -30,6 +30,9 @@ var REFRESH_COMMAND = "__refresh-update-cache";
 var COMPLETE_COMMAND = "__complete";
 var EXIT_DOWN = 1;
 var EXIT_ERROR = 2;
+var DETECT_PORTS = [3e3, 3001, 4200, 4321, 5173, 8e3, 8080];
+var DETECT_PORTS_ENV = "PROBE_DETECT_PORTS";
+var DETECT_TIMEOUT_MS = 300;
 
 // src/errors.ts
 var ProbeError = class extends Error {
@@ -359,14 +362,17 @@ export {
   COMPLETE_COMMAND,
   EXIT_DOWN,
   EXIT_ERROR,
+  DETECT_PORTS,
+  DETECT_PORTS_ENV,
+  DETECT_TIMEOUT_MS,
   ProbeError,
+  targetUrl,
+  curlCommand,
   createColors,
   detectTerminal,
   isInteractive,
   truncate,
   stripStyles,
-  targetUrl,
-  curlCommand,
   runChecks,
   formatCheckResults,
   formatServices