@ninhache/probe 0.2.0 → 0.3.0

package/README.md

@@ -27,23 +27,25 @@ Use the full name with `npx`: `npx probe` is another package.
 
 ## Quick start
 
-1. `probe init` creates `.probe/` and a `probe` block in your `Makefile`.
+1. `probe init` creates `.probe/`.
 2. `probe add api -p 3000 --path /health` declares a service.
-3. `probe check` or `make check` checks everything. Exit code is 1 if a service is down.
-4. Commit `.probe/config.yml`, `.probe/lock.yml` and the `Makefile`.
+3. `probe check` checks everything. Exit code is 1 if a service is down.
+4. Commit `.probe/config.yml`.
+
+Want `make check` too? See [Makefile](#makefile): it is optional.
 
 ## Commands
 
 | Command                                                   | What it does                                                           |
 | --------------------------------------------------------- | ---------------------------------------------------------------------- |
-| `probe init`                                              | Create `.probe/`, the Makefile block and the `.gitignore` entries      |
+| `probe init`                                              | Create `.probe/` and the `.gitignore` entries                          |
 | `probe add <name> -p <port> [--host] [--path] [--expect]` | Add a service                                                          |
 | `probe rm <name>`                                         | 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 status`                                            | CLI version, pending migration, Makefile block state, available update |
-| `probe sync`                                              | Regenerate the Makefile block                                          |
+| `probe sync`                                              | Add or regenerate the Makefile block (optional)                        |
 | `probe migrate`                                           | Migrate `.probe/config.yml` to the current schema                      |
 
 Exit codes: `0` all up, `1` a service is down, `2` usage or config error.
@@ -104,15 +106,15 @@ is judged as is.
 Files in `.probe/`:
 
 - `config.yml`: services. Commit it.
-- `lock.yml`: CLI version and hash of the Makefile block. Commit it.
+- `lock.yml`: CLI version and hash of the Makefile block. Only there once `probe sync` has run. Commit it.
 - `local.yml`: per-machine values (dashboard settings, skipped services). Ignored by git.
 
 Never put secrets in `config.yml` or `lock.yml`.
 
 ## Makefile
 
-`probe init` and `probe sync` write a block between two markers. Everything outside the block is yours and is
-never touched.
+Optional. `probe sync` writes a block between two markers, in a new `Makefile` or at the end of yours. Everything
+outside the block is yours and is never touched. Without a block, no command creates or changes a `Makefile`.
 
 ```make
 # >>> probe (generated - do not edit, run `probe sync`)
@@ -120,6 +122,9 @@ never touched.
 # <<< probe
 ```
 
+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
 your `PATH`, else `npx -y @ninhache/probe@latest`. It works with GNU Make 3.81 (the macOS default).
 

package/dist/cli.js

@@ -305,7 +305,7 @@ async function writeLock(paths, lock) {
 }
 
 // src/version.ts
-var CLI_VERSION = true ? "0.2.0" : "0.0.0-dev";
+var CLI_VERSION = true ? "0.3.0" : "0.0.0-dev";
 
 // src/makefile/generator.ts
 import { createHash } from "crypto";
@@ -419,9 +419,10 @@ function rawServices(loaded) {
   return loaded.raw.services ?? {};
 }
 async function saveServices(loaded, services) {
-  const edited = await blockState(loaded.paths, loaded.config) === "modified";
+  const block = await blockState(loaded.paths, loaded.config);
   const saved = await saveConfig(loaded, { ...loaded.raw, services });
-  if (!edited) {
+  if (block === "missing") return;
+  if (block !== "modified") {
     await syncMakefile(saved.paths, saved.config);
     return;
   }
@@ -625,7 +626,7 @@ async function ignoreLocalFiles(root) {
 var init_default = defineCommand3({
   meta: {
     name: "init",
-    description: "Create .probe/, the .gitignore entries and the Makefile block"
+    description: "Create .probe/ and the .gitignore entries"
   },
   async run() {
     const paths = pathsFor(process.cwd());
@@ -635,9 +636,7 @@ var init_default = defineCommand3({
     await mkdir(paths.dir);
     await writeFile5(paths.config, INITIAL_CONFIG);
     await ignoreLocalFiles(paths.root);
-    const { config } = await loadConfig(paths);
-    await syncMakefile(paths, config);
-    console.log(`Created ${PROBE_DIR}/ and the Makefile block. Next: probe add api -p 3000`);
+    console.log(`Created ${PROBE_DIR}/. Next: probe add api -p 3000`);
   }
 });
 
@@ -768,7 +767,7 @@ function describeBlock(state, colors) {
     case "outdated":
       return colors.yellow("out of date \u2192 run `probe sync`");
     case "missing":
-      return colors.yellow("no probe block \u2192 run `probe sync`");
+      return colors.dim("no probe block (optional) \u2192 `probe sync` adds one");
   }
 }
 function describeUpdate(colors) {
@@ -802,7 +801,10 @@ var status_default = defineCommand7({
 import { relative as relative2 } from "path";
 import { defineCommand as defineCommand8 } from "citty";
 var sync_default = defineCommand8({
-  meta: { name: "sync", description: "Regenerate the probe block of the Makefile" },
+  meta: {
+    name: "sync",
+    description: "Add or regenerate the probe block of the Makefile (optional)"
+  },
   async run() {
     const { config, paths } = await openProject();
     const { created, changed } = await syncMakefile(paths, config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninhache/probe",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Health checks for your local dev services, from the CLI or a generated Makefile",
   "license": "MIT",
   "author": "Ninhache",