@flowmetelev/wfkit 1.0.0

package/README.md

@@ -0,0 +1,120 @@
+# wfkit
+
+`wfkit` is a CLI for building and publishing Webflow code projects.
+
+The npm package installs the native Go binary for your platform during setup.
+
+Supported npm targets:
+
+- macOS `x64` and `arm64`
+- Linux `x64` and `arm64`
+- Windows `x64` and `arm64`
+
+If your platform is outside that matrix, install from source instead of npm.
+
+## Install
+
+Run:
+
+```bash
+npm install -g @flowmetelev/wfkit
+```
+
+## Quick start
+
+Create a project:
+
+```bash
+wfkit init --name my-site
+```
+
+Then:
+
+```bash
+cd my-site
+bun install
+bun run start
+```
+
+This starts a local proxy on `http://localhost:3000` and injects your Vite scripts into proxied HTML only. The published `.webflow.io` site stays unchanged for everyone else.
+
+To expose the proxy on your local network, run:
+
+```bash
+wfkit proxy --host 192.168.1.25
+```
+
+When you're ready to ship:
+
+```bash
+wfkit publish --env prod
+```
+
+To preview the publish plan without changing GitHub or Webflow:
+
+```bash
+wfkit publish --env prod --dry-run
+```
+
+## Main commands
+
+### `wfkit init`
+
+Create a new project scaffold, including `wfkit.json`.
+
+### `wfkit proxy`
+
+Proxy your published `.webflow.io` site locally and inject local dev scripts.
+
+### `wfkit publish`
+
+Build and publish your code to Webflow.
+
+### `wfkit doctor`
+
+Check config, local tools, auth, and ports.
+
+### `wfkit update`
+
+Check for CLI updates.
+
+## Configure the project
+
+`wfkit.json` is the main project config file.
+
+Example:
+
+```json
+{
+  "appName": "my-site",
+  "siteUrl": "https://my-site.webflow.io",
+  "ghUserName": "your-username",
+  "repositoryName": "your-repo",
+  "packageManager": "bun",
+  "branch": "main",
+  "buildDir": "dist/assets",
+  "devHost": "localhost",
+  "devPort": 5173,
+  "proxyHost": "localhost",
+  "proxyPort": 3000,
+  "openBrowser": true,
+  "globalEntry": "src/global/index.ts"
+}
+```
+
+Generated projects follow this structure:
+
+```text
+src/
+  global/
+  pages/
+  utils/
+build/
+dist/assets/
+```
+
+`wfkit` builds a `wfkit-manifest.json` file in `dist/assets` so page and global publish flows can resolve the right scripts without guessing filenames.
+
+## Legacy dev mode
+
+`wfkit publish --env dev` still works, but `wfkit proxy` is the recommended development flow.

package/bin/wfkit.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+const { existsSync } = require("fs");
+const { join } = require("path");
+const { spawnSync } = require("child_process");
+
+const platform = process.platform;
+const binaryName = platform === "win32" ? "wfkit.exe" : "wfkit";
+const binaryPath = join(__dirname, binaryName);
+
+if (!existsSync(binaryPath)) {
+  console.error(
+    `wfkit binary is missing at ${binaryPath}. Reinstall the package to run the postinstall download again.`,
+  );
+  process.exit(1);
+}
+
+const result = spawnSync(binaryPath, process.argv.slice(2), {
+  stdio: "inherit",
+});
+
+if (result.error) {
+  console.error(`Failed to start wfkit: ${result.error.message}`);
+  process.exit(1);
+}
+
+process.exit(result.status === null ? 1 : result.status);

package/install.js

@@ -0,0 +1,136 @@
+const { join } = require("path");
+const { createWriteStream, existsSync, mkdirSync } = require("fs");
+const { promisify } = require("util");
+const { exec } = require("child_process");
+const https = require("https");
+const packageJSON = require("./package.json");
+
+const pipeline = promisify(require("stream").pipeline);
+const repositorySlug = "flowmetelev/wfkit";
+const supportedTargets = new Map([
+  ["darwin:arm64", "wfkit-darwin-arm64"],
+  ["darwin:x64", "wfkit-darwin-amd64"],
+  ["linux:arm64", "wfkit-linux-arm64"],
+  ["linux:x64", "wfkit-linux-amd64"],
+  ["win32:arm64", "wfkit-windows-arm64.exe"],
+  ["win32:x64", "wfkit-windows-amd64.exe"],
+]);
+
+function resolveReleaseAsset(platform = process.platform, arch = process.arch) {
+  const targetKey = `${platform}:${arch}`;
+  const binaryName = supportedTargets.get(targetKey);
+
+  if (!binaryName) {
+    const supportedList = Array.from(supportedTargets.keys())
+      .map((target) => target.replace(":", "/"))
+      .join(", ");
+    throw new Error(
+      `Unsupported platform ${platform}/${arch}. Supported targets: ${supportedList}.`,
+    );
+  }
+
+  return binaryName;
+}
+
+function resolveVersion() {
+  return process.env.npm_package_version || packageJSON.version;
+}
+
+function buildReleaseURL(binaryName, version = resolveVersion()) {
+  const normalizedVersion = String(version || "").trim();
+  if (!normalizedVersion) {
+    throw new Error("Package version is empty, cannot resolve release URL.");
+  }
+
+  return `https://github.com/${repositorySlug}/releases/download/v${normalizedVersion}/${binaryName}`;
+}
+
+function download(url, destPath) {
+  return new Promise((resolve, reject) => {
+    const request = (downloadUrl, redirectCount = 0) => {
+      if (redirectCount > 5) {
+        reject(new Error("Too many redirects while downloading the binary."));
+        return;
+      }
+
+      https
+        .get(
+          downloadUrl,
+          {
+            headers: {
+              "user-agent": "wfkit-npm-installer",
+            },
+          },
+          (response) => {
+            if (
+              response.statusCode >= 300 &&
+              response.statusCode < 400 &&
+              response.headers.location
+            ) {
+              response.resume();
+              request(response.headers.location, redirectCount + 1);
+              return;
+            }
+
+            if (response.statusCode !== 200) {
+              response.resume();
+              reject(
+                new Error(
+                  `Failed to download binary: HTTP ${response.statusCode} ${response.statusMessage || ""}`.trim(),
+                ),
+              );
+              return;
+            }
+
+            const fileStream = createWriteStream(destPath);
+            pipeline(response, fileStream).then(resolve).catch(reject);
+          },
+        )
+        .on("error", reject);
+    };
+
+    request(url);
+  });
+}
+
+async function downloadBinary() {
+  const platform = process.platform;
+  const arch = process.arch;
+  const binaryName = resolveReleaseAsset(platform, arch);
+  const version = resolveVersion();
+  const url = buildReleaseURL(binaryName, version);
+  const binDir = join(__dirname, "bin");
+
+  if (!existsSync(binDir)) {
+    mkdirSync(binDir, { recursive: true });
+  }
+
+  const destPath = join(binDir, platform === "win32" ? "wfkit.exe" : "wfkit");
+
+  console.log(`Downloading wfkit binary for ${platform} (${arch})...`);
+  console.log(`From: ${url}`);
+
+  await download(url, destPath);
+
+  if (platform !== "win32") {
+    await promisify(exec)(`chmod +x "${destPath}"`);
+  }
+
+  console.log("wfkit installed successfully!");
+}
+
+module.exports = {
+  buildReleaseURL,
+  downloadBinary,
+  repositorySlug,
+  resolveReleaseAsset,
+  resolveVersion,
+  supportedTargets,
+};
+
+if (require.main === module) {
+  downloadBinary().catch((err) => {
+    console.error("Failed to install wfkit:", err.message);
+    process.exit(1);
+  });
+}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@flowmetelev/wfkit",
+  "version": "1.0.0",
+  "description": "A powerful CLI utility for securely publishing Webflow projects with live development support.",
+  "main": "install.js",
+  "bin": {
+    "wfkit": "bin/wfkit.js"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
+  },
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flowmetelev/wfkit.git"
+  },
+  "keywords": [
+    "webflow",
+    "cli",
+    "publish",
+    "development",
+    "deploy",
+    "sync"
+  ],
+  "author": "Dmitry Metelev <mailmetelev@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/flowmetelev/wfkit/issues"
+  },
+  "homepage": "https://github.com/flowmetelev/wfkit#readme",
+  "files": [
+    "bin/",
+    "install.js",
+    "package.json",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}