@brillout/test-e2e 0.5.28 → 0.5.29

package/dist/testScreenshotFixture.js

@@ -17,14 +17,33 @@ async function testScreenshotFixture({ screenshotFixturePath, doNotTestLocally,
     const pngPaths = getPngPaths();
     const pngFixturPath = screenshotFixturePath || pngPaths.pngFixturPath;
     if (doNotTestLocally && !(0, utils_1.isCI)()) {
-        console.log(`\n${picocolors_1.default.blue('INFO')} screenshot test skipped (because running test locally, i.e. not in a CI environment): ${pngFixturPath}`);
+        console.log(`\n${picocolors_1.default.blue('INFO')} test screenshot fixture ${pngFixturPath} ${picocolors_1.default.bold('skipped')}. (Because ${picocolors_1.default.cyan('doNotTestLocally: true')} and test is being run locally, i.e. not in a CI environment.)`);
         return;
     }
-    if (!fs_1.default.existsSync(pngFixturPath)) {
+    const fixtureMissing = !fs_1.default.existsSync(pngFixturPath);
+    if (fixtureMissing) {
         const pngActual = await takeScreenshot();
         const fileContent = pngjs_1.PNG.sync.write(pngActual);
-        fs_1.default.writeFileSync(pngFixturPath, fileContent);
-        throw new Error(`Screenshot fixture missing. Screenshot fixture created at ${pngFixturPath}. You can now re-run the test and the screenshot fixture test will pass.`);
+        const { pngExpectPath } = pngPaths;
+        const filPath = (0, utils_1.isCI)() ? pngExpectPath : pngFixturPath;
+        fs_1.default.writeFileSync(filPath, fileContent);
+        console.log('Expect image written at', pngExpectPath);
+        const errMsgs = [
+            //
+            'Screenshot fixture missing. Screenshot fixture created at:',
+            `  ${filPath}`,
+        ];
+        if (!(0, utils_1.isCI)()) {
+            errMsgs.push('You can now re-run the test and the screenshot fixture test will pass.');
+        }
+        else {
+            errMsgs.push([
+                'The screnshot fixture was uploaded as GitHub Workflow Artifact.',
+                `(See ${picocolors_1.default.bold('Summary')} > ${picocolors_1.default.bold('Artifacts')}, and make sure to use the ${picocolors_1.default.bold('actions/upload-artifact@v3')} action.)`,
+                `Download the fixture, check it into the repository (so that it lives at ${pngFixturPath}), and try again: the test should now pass.`,
+            ].join(' '));
+        }
+        throw new Error(errMsgs.join('\n'));
     }
     const pngExpect = pngjs_1.PNG.sync.read(fs_1.default.readFileSync(pngFixturPath));
     const pngActual = await takeScreenshot();
@@ -39,16 +58,16 @@ async function testScreenshotFixture({ screenshotFixturePath, doNotTestLocally,
     catch (err) {
         const { pngExpectPath, pngActualPath, pngDifferPath } = pngPaths;
         {
-            console.log('Actual image written at', pngActualPath);
             fs_1.default.writeFileSync(pngActualPath, pngjs_1.PNG.sync.write(pngActual));
+            console.log('Actual image written at', pngActualPath);
         }
         {
-            console.log('Expect image written at', pngExpectPath);
             fs_1.default.writeFileSync(pngExpectPath, pngjs_1.PNG.sync.write(pngExpect));
+            console.log('Expect image written at', pngExpectPath);
         }
         {
-            console.log('Differ image written at', pngDifferPath);
             fs_1.default.writeFileSync(pngDifferPath, pngjs_1.PNG.sync.write(pngDiffer));
+            console.log('Differ image written at', pngDifferPath);
         }
         throw err;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/test-e2e",
-  "version": "0.5.28",
+  "version": "0.5.29",
   "bin": "./bin.js",
   "main": "./dist/index.js",
   "scripts": {
@@ -10,15 +10,24 @@
     "build": "rm -rf dist/ && tsc",
     "// === Release ===": "",
     "prepublishOnly": "pnpm run build",
-    "release": "npm version patch && npm publish && git push && git push --tags"
+    "release": "npm version patch && npm publish && git push && git push --tags",
+    "========= Clean": "",
+    "reset": "git clean -Xdf && pnpm install && pnpm run build",
+    "========= Formatting": "",
+    "format": "pnpm run format:biome",
+    "format:prettier": "git ls-files | egrep '\\.(json|js|jsx|css|ts|tsx|vue|mjs|cjs)$' | grep --invert-match package.json | xargs pnpm exec prettier --write",
+    "format:biome": "biome format --write .",
+    "format:check": "biome format . || echo Fix formatting by running: $ pnpm run format",
+    "========= Only allow pnpm; forbid yarn & npm": "",
+    "preinstall": "npx only-allow pnpm"
   },
   "dependencies": {
     "@brillout/part-regex": "^0.1.3",
+    "@brillout/picocolors": "^1.0.9",
     "chai": "^4.3.6",
     "esbuild": "^0.16.5",
     "fast-glob": "^3.2.12",
     "node-fetch": "^2.6.1",
-    "@brillout/picocolors": "^1.0.9",
     "pixelmatch": "^5.3.0",
     "playwright-chromium": "^1.22.2",
     "pngjs": "^6.0.0",
@@ -26,14 +35,17 @@
     "strip-ansi": "^6.0.1"
   },
   "devDependencies": {
+    "@biomejs/biome": "^1.5.3",
     "@types/chai": "^4.3.3",
     "@types/node": "^15.6.1",
     "@types/node-fetch": "^2.5.12",
     "@types/pixelmatch": "^5.2.4",
     "@types/pngjs": "^6.0.1",
     "@types/source-map-support": "^0.5.6",
+    "prettier": "^3.2.5",
     "typescript": "^4.8.3"
   },
+  "packageManager": "pnpm@8.15.1",
   "repository": "github:brillout/test-e2e",
   "files": [
     "dist/"