local-storefront 0.1.1

package/README.md

@@ -0,0 +1,34 @@
+# local-storefront
+
+A local storefront for Shopify themes. Its command, `lsf`, serves a theme from your machine,
+rendered from JSON fixtures instead of the Shopify API: no network, no rate limit, and each
+test gets exactly the catalog, cart and customer it asks for.
+
+```bash
+npm install --save-dev local-storefront
+```
+
+```bash
+npx lsf serve
+```
+
+With Playwright:
+
+```ts
+// playwright.config.ts
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: { baseURL: 'http://127.0.0.1:9292' },
+  webServer: {
+    command: 'npx lsf serve --port 9292 --static --quiet --strict',
+    url: 'http://127.0.0.1:9292/__lsf/status',
+    reuseExistingServer: !process.env.CI,
+  },
+});
+```
+
+This package only contains a launcher. The `lsf` binary comes from a platform package that
+npm installs alongside it: macOS, Linux and Windows, on x64 and arm64.
+
+Documentation: <https://github.com/0xtlt/local-storefront>

package/bin/lsf.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+'use strict';
+
+// Runs the lsf binary npm installed for this platform, passing everything through.
+//
+// The binary lives in a package of its own, `local-storefront-<platform>-<arch>`, listed in
+// the optional dependencies of this one: npm installs the one that matches the machine.
+
+const { spawn } = require('node:child_process');
+
+const SUPPORTED = ['darwin-arm64', 'darwin-x64', 'linux-arm64', 'linux-x64', 'win32-arm64', 'win32-x64'];
+
+const platform = `${process.platform}-${process.arch}`;
+const name = `local-storefront-${platform}`;
+const file = process.platform === 'win32' ? 'lsf.exe' : 'lsf';
+
+let binary;
+try {
+  binary = require.resolve(`${name}/bin/${file}`);
+} catch {
+  const reason = SUPPORTED.includes(platform)
+    ? `The package ${name} is not installed. It is an optional dependency: reinstall without\n` +
+      '--omit=optional (npm) or --no-optional (yarn, pnpm).'
+    : `There is no build for ${platform}. Supported: ${SUPPORTED.join(', ')}.`;
+  console.error(`local-storefront: cannot find the lsf binary.\n${reason}`);
+  process.exit(1);
+}
+
+const child = spawn(binary, process.argv.slice(2), { stdio: 'inherit' });
+
+// A runner that stops this process (Playwright's webServer, a CI step) must stop the server.
+const signals = ['SIGINT', 'SIGTERM', 'SIGHUP'];
+const forward = (signal) => child.kill(signal);
+for (const signal of signals) process.on(signal, forward);
+
+child.on('error', (error) => {
+  console.error(`local-storefront: cannot run ${binary}: ${error.message}`);
+  process.exit(1);
+});
+
+child.on('exit', (code, signal) => {
+  if (signal) {
+    // End the same way the binary did, so that the caller sees the signal.
+    for (const name of signals) process.removeListener(name, forward);
+    process.kill(process.pid, signal);
+  } else {
+    process.exit(code ?? 1);
+  }
+});

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "local-storefront",
+  "version": "0.1.1",
+  "description": "A local storefront for Shopify themes: lsf renders a theme from JSON fixtures, without the Shopify API, for fast end-to-end tests.",
+  "keywords": [
+    "shopify",
+    "theme",
+    "liquid",
+    "storefront",
+    "e2e",
+    "testing",
+    "playwright"
+  ],
+  "license": "MIT",
+  "homepage": "https://github.com/0xtlt/local-storefront#readme",
+  "bugs": "https://github.com/0xtlt/local-storefront/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xtlt/local-storefront.git"
+  },
+  "bin": {
+    "lsf": "bin/lsf.js"
+  },
+  "files": [
+    "bin/lsf.js"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "local-storefront-darwin-arm64": "0.1.1",
+    "local-storefront-darwin-x64": "0.1.1",
+    "local-storefront-linux-arm64": "0.1.1",
+    "local-storefront-linux-x64": "0.1.1",
+    "local-storefront-win32-arm64": "0.1.1",
+    "local-storefront-win32-x64": "0.1.1"
+  }
+}