docs(@whook/example): improve the example docs

Author: nfroidure

packages/whook-example/README.md

@@ -23,7 +23,7 @@ To run the server in production:
 # For the first time create a strong JWT secret
 echo 'JWT_SECRET=$(openssl rand -base64 10)' > .env.app.production
 # And install the dependencies
-npm it
+npm i
 
 # Then and later, just run build and run the server
 npm run build
@@ -39,8 +39,8 @@ that explains the notes.
 Feel free to continue creating architecture notes and to regenerate the markdown
 file by running:
 
-```
-npm run architecture
+```sh
+node --run architecture
 ```
 
 ## Dev
@@ -55,6 +55,15 @@ node --run dev
 node --run watch
 ```
 
+Run and update tests:
+```sh
+# Run the tests
+npm t
+
+# Updating tests snapshots
+node --run jest -- -u
+```
+
 Create a new route / cron / service / provider or command:
 
 ```sh

packages/whook-example/src/cli.test.ts

@@ -1,6 +1,7 @@
 import { describe, test, expect, jest } from '@jest/globals';
 import { exec } from 'node:child_process';
 import { YError } from 'yerror';
+import { join as joinPaths } from 'node:path';
 
 jest.setTimeout(30000);
 
@@ -11,11 +12,11 @@ describe('commands should work', () => {
     );
 
     expect({
-      stdout: stdout.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
-      stderr: stderr.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
+      stdout: replacePaths(stdout),
+      stderr: replacePaths(stderr),
     }).toMatchInlineSnapshot(`
 {
-  "stderr": "⚡ - Loading configurations from /whook/packages/whook-example/dist/config/local/config.js".
+  "stderr": "⚡ - Loading configurations from "file:///project/dist/config/local/config.js".
 🤖 - Initializing the \`$autoload\` service.
 🔴 - Running with "local" application environment.
 🔂 - Running with "test" node environment.
@@ -56,11 +57,11 @@ On air 🚀🌕
     );
 
     expect({
-      stdout: stdout.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
-      stderr: stderr.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
+      stdout: replacePaths(stdout),
+      stderr: replacePaths(stderr),
     }).toMatchInlineSnapshot(`
 {
-  "stderr": "⚡ - Loading configurations from /whook/packages/whook-example/dist/config/local/config.js".
+  "stderr": "⚡ - Loading configurations from "file:///project/dist/config/local/config.js".
 🤖 - Initializing the \`$autoload\` service.
 🔴 - Running with "local" application environment.
 🔂 - Running with "test" node environment.
@@ -80,11 +81,11 @@ On air 🚀🌕
     );
 
     expect({
-      stdout: stdout.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
-      stderr: stderr.replace(/( |"|')([^ ]+)\/whook\//g, ' /whook/'),
+      stdout: replacePaths(stdout),
+      stderr: replacePaths(stderr),
     }).toMatchInlineSnapshot(`
 {
-  "stderr": "⚡ - Loading configurations from /whook/packages/whook-example/dist/config/local/config.js".
+  "stderr": "⚡ - Loading configurations from "file:///project/dist/config/local/config.js".
 🤖 - Initializing the \`$autoload\` service.
 🔴 - Running with "local" application environment.
 🔂 - Running with "test" node environment.
@@ -112,3 +113,10 @@ async function execCommand(
     });
   });
 }
+
+function replacePaths(text: string) {
+  return text.replaceAll(
+    joinPaths(import.meta.dirname, '..').replace(/^file:\/\//, ''),
+    '/project',
+  );
+}