claude init and npm scripts refactoring (#755)

Author: avine

CLAUDE.md

@@ -14,20 +14,20 @@ zenika
 
 ## How to update the data?
 
-If you need to update emulator data, temporarily add the option `--export-on-exit` to the end of the NPM `firebase:emulators` script like this:
+If you need to update emulator data, temporarily add the option `--export-on-exit` to the end of the NPM `firebase:emulators:watch` script like this:
 
 ```json
 {
   "scripts": {
-    "firebase:emulators": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data --export-on-exit"
+    "firebase:emulators:watch": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data --export-on-exit"
   }
 }
 ```
 
 Then run the command:
 
 ```bash
-npm run firebase:emulators
+npm run firebase:emulators:watch
 ```
 
 The data will be exported when you terminate the command execution.

client/firebase-emulators-data/README.md

@@ -5,10 +5,10 @@
     "ng": "ng",
     "start": "ng serve",
     "start:en": "ng serve -c development-en",
-    "start:emulators": "ng serve -c development-emulators",
+    "start:emulators:watch": "ng serve -c development-emulators",
     "build": "ng build",
     "build:dev": "ng build -c development-remote && npm run post-build",
-    "build:e2e": "ng build -c development,emulators --localize --base-href=\"/\" && npm run post-build",
+    "build:emulators": "ng build -c development,emulators --localize --base-href=\"/\" && npm run post-build",
     "build:staging": "ng build -c staging && npm run post-build",
     "build:production": "ng build -c production && npm run post-build",
     "post-build": "cp src/404.html dist/client/browser/404.html",
@@ -22,13 +22,13 @@
     "format:check": "prettier --check .",
     "bundle-visualizer": "ng build --localize false --named-chunks && cd ./dist/client/browser && npx vite-bundle-visualizer && cd -",
     "server": "npm --prefix ../server start",
-    "firebase:emulators": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data",
+    "firebase:emulators:watch": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data",
+    "server:emulators:watch": "npm --prefix ../server run start:emulators:watch",
+    "stack:emulators:watch": "concurrently \"npm run firebase:emulators:watch\" \"npm run server:emulators:watch\" \"npm run start:emulators:watch\"",
+    "firebase:emulators": "firebase emulators:start --only auth:dev,firestore:dev,hosting:dev --import ./firebase-emulators-data",
     "server:emulators": "npm --prefix ../server run start:emulators",
-    "stack:emulators": "concurrently \"npm run firebase:emulators\" \"npm run server:emulators\" \"npm run start:emulators\"",
-    "firebase:e2e": "firebase emulators:start --only auth:dev,firestore:dev,hosting:dev --import ./firebase-emulators-data",
-    "server:e2e": "npm --prefix ../server run start:e2e",
-    "prestack:e2e": "npm run build:e2e",
-    "stack:e2e": "concurrently \"npm run firebase:e2e\" \"npm run server:e2e\"",
+    "prestack:emulators": "npm run build:emulators",
+    "stack:emulators": "concurrently \"npm run firebase:emulators\" \"npm run server:emulators\"",
     "e2e:install": "playwright install",
     "e2e:test": "playwright test",
     "e2e:report": "playwright show-report",

client/package.json

@@ -78,7 +78,7 @@ export default defineConfig({
 
   /* Run your local dev server before starting the tests */
   webServer: {
-    command: 'npm run stack:e2e',
+    command: 'npm run stack:emulators',
     reuseExistingServer: !process.env['CI'],
     port: 4200,
     timeout: 60_000,

client/playwright.config.ts

@@ -36,17 +36,17 @@ export default defineConfig({
 
   // Run your local dev server before starting the tests
   webServer: {
-    command: 'npm run stack:e2e',
+    command: 'npm run stack:emulators',
     port: 4200,
     reuseExistingServer: !process.env['CI'],
   },
 });
 ```
 
-Before starting the tests, Playwright executes the command `npm run stack:e2e` and waits for the application to be available on port `4200`.
+Before starting the tests, Playwright executes the command `npm run stack:emulators` and waits for the application to be available on port `4200`.
 Due to the `reuseExistingServer` option (enabled for non-CI environment), the command will not be executed if the application is already available.
 
-Therefore, you can run the command `npm run stack:e2e` in one terminal, wait for the application to be available on port `4200`, and then run the command `npm run e2e:test` in another terminal.
+Therefore, you can run the command `npm run stack:emulators` in one terminal, wait for the application to be available on port `4200`, and then run the command `npm run e2e:test` in another terminal.
 In this case, Playwright will skip the `webServer.command`, starting the tests immediately.
 
 ## Running Playwright
@@ -71,13 +71,13 @@ To avoid this problem, use the method 2 instead.
 To start the app once and then have Playwright only start the tests, run the following commands in two separate terminals:
 
 ```bash
-npm run stack:e2e # First terminal
+npm run stack:emulators # First terminal
 ```
 
+:::tip
+As an alternative, run `npm run stack:emulators:watch` instead, to start the app in "watch" mode.
+:::
+
 ```bash
 npm run e2e:test # Second terminal
 ```
-
-:::tip
-As an alternative to the above command in the first terminal, run `npm run stack:emulators` instead, to start the app in "watch" mode.
-:::

docs-source/docs/technical-guides/e2e-testing.md

@@ -18,7 +18,7 @@ When using the Firebase emulator, the Google Auth provider is no longer availabl
 Only the Email/Password provider is enabled.
 :::
 
-## `*:emulators` scripts
+## `*:emulators:watch` scripts
 
 In this execution context, the _client_ and _server_ apps are running in "watch" mode.
 
@@ -30,22 +30,22 @@ Here are the NPM scripts for this execution context:
 {
   "scripts": {
     // Start Firebase "Auth" and "Firestore" emulators
-    "firebase:emulators": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data",
+    "firebase:emulators:watch": "firebase emulators:start --only auth:dev,firestore:dev --import ./firebase-emulators-data",
 
     // Start the server app in "watch" mode
-    "server:emulators": "npm --prefix ../server run start:emulators",
+    "server:emulators:watch": "npm --prefix ../server run start:emulators:watch",
 
     // Start the client app in "watch" mode
-    "start:emulators": "ng serve -c development-emulators",
+    "start:emulators:watch": "ng serve -c development-emulators",
 
     // ----------------------------------------
     // Run all the previous scripts in parallel
-    "stack:emulators": "concurrently \"npm run firebase:emulators\" \"npm run server:emulators\" \"npm run start:emulators\""
+    "stack:emulators:watch": "concurrently \"npm run firebase:emulators:watch\" \"npm run server:emulators:watch\" \"npm run start:emulators:watch\""
   }
 }
 ```
 
-## `*:e2e` scripts
+## `*:emulators` scripts
 
 In this execution context, the _client_ and _server_ apps are built before running.
 
@@ -60,17 +60,17 @@ Here are the NPM scripts for this execution context:
 {
   "scripts": {
     // Start Firebase "Auth", "Firestore" and "Hosting" emulators
-    "firebase:e2e": "firebase emulators:start --only auth:dev,firestore:dev,hosting:dev --import ./firebase-emulators-data",
+    "firebase:emulators": "firebase emulators:start --only auth:dev,firestore:dev,hosting:dev --import ./firebase-emulators-data",
 
     // Build and start the server app (see "<rootDir>/server/package.json" scripts for details)
-    "server:e2e": "npm --prefix ../server run start:e2e",
+    "server:emulators": "npm --prefix ../server run start:emulators",
 
     // Only build the client app (it will be served by Firebase "Hosting")
-    "prestack:e2e": "npm run build:e2e",
+    "prestack:emulators": "npm run build:emulators",
 
     // ----------------------------------------
     // Run all the previous scripts in parallel
-    "stack:e2e": "concurrently \"npm run firebase:e2e\" \"npm run server:e2e\""
+    "stack:emulators": "concurrently \"npm run firebase:emulators\" \"npm run server:emulators\""
   }
 }
 ```