fix(@whook/example): fix whook example run scripts

nfroidure · Dec 5, 2024 · 38c0992 · 38c0992
1 parent 3415505
commit 38c0992
Show file tree

Hide file tree

Showing 13 changed files with 85 additions and 109 deletions.
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ npm init @whook;
 cd my_project_name;
 
 # Check install with a dry run of the server
-DRY_RUN=1 npm run start
+npm run dev -- __inject httpServer,process,dryRun
 
 # Run tests
 npm t
@@ -46,8 +46,14 @@ npm run watch
 # Build the project
 npm run build
 
+# Start the compiled project
+npm start
+
+# Start the built project
+node builds/local/server/start.js
+
 # Create a new handler/service/provider
-npx whook create
+npm run whook -- create
 ```
 
 ## Why use Whook?
@@ -59,7 +65,7 @@ npx whook create
   anylith era
 - easy to test: TDD, E2E tests made easy
 - feature complete for most API use cases
-- simplify your life but embrace projects complexity
+- ease your work but embrace projects complexity
 
 ## Usage
 
@@ -69,6 +75,7 @@ A tutorial is still to be written, expect it to come very soon. The above
 That said you can check the following "How to" PRs:
 
 - [add GraphQL](https://github.com/nfroidure/whook/pull/62)
+- [deploy with Docker](https://github.com/nfroidure/whook/pull/164)
 - [deploy on AWS Lambda](https://github.com/nfroidure/whook/pull/54)
 - [deploy with GCP Cloud Functions](https://github.com/nfroidure/whook/pull/66)
 

diff --git a/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap b/packages/whook-create/src/services/__snapshots__/createWhook.test.ts.snap
@@ -103,18 +103,18 @@ DEV_MODE=1
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook"
   },
   "files": [
@@ -311,7 +311,7 @@ exports[`initCreateWhook should handle git initialization problems 2`] = `
     ],
     [
       "warning",
-      "➕ - Then run \`DRY_RUN=1 npm run dev\` to check installation.",
+      "➕ - Then run \`npm run dev -- __inject httpServer,process,dryRun\` to check installation.",
     ],
     [
       "warning",
@@ -410,18 +410,18 @@ DEV_MODE=1
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook"
   },
   "files": [
@@ -656,7 +656,7 @@ exports[`initCreateWhook should handle network issues 2`] = `
     ],
     [
       "warning",
-      "➕ - Then run \`DRY_RUN=1 npm run dev\` to check installation.",
+      "➕ - Then run \`npm run dev -- __inject httpServer,process,dryRun\` to check installation.",
     ],
     [
       "warning",
@@ -755,18 +755,18 @@ DEV_MODE=1
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook"
   },
   "files": [
@@ -984,7 +984,7 @@ exports[`initCreateWhook should work 2`] = `
     ],
     [
       "warning",
-      "➕ - Then run \`DRY_RUN=1 npm run dev\` to check installation.",
+      "➕ - Then run \`npm run dev -- __inject httpServer,process,dryRun\` to check installation.",
     ],
     [
       "warning",
@@ -1083,18 +1083,18 @@ DEV_MODE=1
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook"
   },
   "files": [

diff --git a/packages/whook-create/src/services/createWhook.test.ts b/packages/whook-create/src/services/createWhook.test.ts
@@ -146,12 +146,12 @@ describe('initCreateWhook', () => {
     await createWhook();
 
     expect(
-      JSON.parse(
-        outputFile.mock.calls
-          .find((call) => call[0].toString().endsWith('package.json'))?.[1]
-          ?.toString() || '',
-      ),
-    ).toMatchInlineSnapshot(`
+  JSON.parse(
+    outputFile.mock.calls.
+    find((call) => call[0].toString().endsWith('package.json'))?.[1]?.
+    toString() || ''
+  )
+).toMatchInlineSnapshot(`
 {
   "author": {
     "email": "[email protected]",
@@ -262,18 +262,18 @@ describe('initCreateWhook', () => {
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook",
   },
   "type": "module",
@@ -341,12 +341,12 @@ describe('initCreateWhook', () => {
     await createWhook();
 
     expect(
-      JSON.parse(
-        outputFile.mock.calls
-          .find((call) => call[0].toString().endsWith('package.json'))?.[1]
-          ?.toString() || '',
-      ),
-    ).toMatchInlineSnapshot(`
+  JSON.parse(
+    outputFile.mock.calls.
+    find((call) => call[0].toString().endsWith('package.json'))?.[1]?.
+    toString() || ''
+  )
+).toMatchInlineSnapshot(`
 {
   "author": {
     "email": "[email protected]",
@@ -457,18 +457,18 @@ describe('initCreateWhook', () => {
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook",
   },
   "type": "module",
@@ -521,12 +521,12 @@ describe('initCreateWhook', () => {
     await createWhook();
 
     expect(
-      JSON.parse(
-        outputFile.mock.calls
-          .find((call) => call[0].toString().endsWith('package.json'))?.[1]
-          ?.toString() || '',
-      ),
-    ).toMatchInlineSnapshot(`
+  JSON.parse(
+    outputFile.mock.calls.
+    find((call) => call[0].toString().endsWith('package.json'))?.[1]?.
+    toString() || ''
+  )
+).toMatchInlineSnapshot(`
 {
   "author": {
     "email": "[email protected]",
@@ -637,18 +637,18 @@ describe('initCreateWhook', () => {
     "build": "rimraf 'dist' && tsc --outDir dist",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=\${NODE_OPTIONS:-'--inspect'} NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=\${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
-    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=\${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=\${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=\${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=\${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=\${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=\${NODE_ENV:-development} whook",
   },
   "type": "module",

diff --git a/packages/whook-create/src/services/createWhook.ts b/packages/whook-create/src/services/createWhook.ts
@@ -281,7 +281,7 @@ builds/
     );
     log(
       'warning',
-      `➕ - Then run \`DRY_RUN=1 npm run dev\` to check installation.`,
+      `➕ - Then run \`npm run dev -- __inject httpServer,process,dryRun\` to check installation.`,
     );
     log('warning', `➕ - And finally run \`npm run watch\` to start dev!`);
   };

diff --git a/packages/whook-example/bin/build.js b/packages/whook-example/bin/build.js
diff --git a/packages/whook-example/bin/watch.js b/packages/whook-example/bin/watch.js
diff --git a/packages/whook-example/bin/whook.js b/packages/whook-example/bin/whook.js
diff --git a/packages/whook-example/package.json b/packages/whook-example/package.json
@@ -48,19 +48,19 @@
     "cli": "env NODE_ENV=${NODE_ENV:-cli}",
     "cover": "npm run jest -- --coverage",
     "debug": "NODE_OPTIONS=${NODE_OPTIONS:-'--inspect'} NODE_ENV=${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 DEBUG=${DEBUG:-whook} tsx bin/whook.js",
-    "dev": "NODE_ENV=${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/whook.js",
+    "dev": "NODE_ENV=${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/run.js",
     "format": "npm run prettier",
     "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
     "lint": "eslint 'src/**/*.ts'",
     "metapak": "metapak",
-    "postbuild": "NODE_ENV=${NODE_ENV:-development} tsx bin/build.js",
+    "postbuild": "NODE_ENV=${NODE_ENV:-development} tsx src/runBuild.js",
     "prettier": "prettier --write 'src/**/*.ts'",
     "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
-    "repl": "NODE_ENV=${NODE_ENV:-development} tsx bin/whook.js -- __inject repl",
-    "start": "NODE_ENV=${NODE_ENV:-development} node bin/whook.js",
+    "repl": "NODE_ENV=${NODE_ENV:-development} tsx src/run.js -- __inject repl",
+    "start": "NODE_ENV=${NODE_ENV:-development} node dist/run.js",
     "test": "NODE_ENV=test npm run build && npm run jest",
     "type-check": "tsc --pretty --noEmit",
-    "watch": "NODE_ENV=${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx bin/watch.js",
+    "watch": "NODE_ENV=${NODE_ENV:-development} DEV_MODE=1 DESTROY_SOCKETS=1 tsx src/runWatch.js",
     "whook": "NODE_ENV=${NODE_ENV:-development} whook"
   },
   "author": {