@testflowkit/cli 2.0.0

package/README.md

@@ -0,0 +1,81 @@
+# @testflowkit/cli
+
+[![npm version](https://img.shields.io/npm/v/@testflowkit/cli.svg)](https://www.npmjs.com/package/@testflowkit/cli)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**TestFlowKit CLI** - A powerful end-to-end testing framework using Gherkin syntax.
+
+## Installation
+
+```bash
+# Global installation (recommended)
+npm install -g @testflowkit/cli
+
+# Or use npx directly
+npx @testflowkit/cli --version
+```
+
+## Usage
+
+### Initialize a new test project
+
+```bash
+tkit init
+```
+
+### Run tests
+
+```bash
+tkit run
+```
+
+### Validate Gherkin files
+
+```bash
+tkit validate
+```
+
+### Check version
+
+```bash
+tkit --version
+```
+
+## Configuration
+
+Create a `config.yml` file in your project root:
+
+```yaml
+mode: frontend
+browser:
+  type: chromium
+  headless: true
+features:
+  - path: ./features
+```
+
+## Documentation
+
+For full documentation, visit [TestFlowKit Documentation](https://testflowkit.github.io/testflowkit/).
+
+## Supported Platforms
+
+| OS      | Architecture |
+|---------|--------------|
+| Linux   | x64, arm64   |
+| macOS   | x64, arm64   |
+| Windows | x64, arm64   |
+
+## Requirements
+
+- Node.js >= 16.0.0
+
+## License
+
+MIT © [TestFlowKit](https://github.com/TestFlowKit)
+
+## Links
+
+- [GitHub Repository](https://github.com/TestFlowKit/testflowkit)
+- [Issue Tracker](https://github.com/TestFlowKit/testflowkit/issues)
+- [Releases](https://github.com/TestFlowKit/testflowkit/releases)

package/lib/index.js

@@ -0,0 +1,48 @@
+/**
+ * @testflowkit/cli
+ *
+ * This package provides the TestFlowKit CLI (tkit) for running
+ * end-to-end tests using Gherkin syntax.
+ *
+ * Usage:
+ *   npx @testflowkit/cli run
+ *   npx @testflowkit/cli init
+ *   npx @testflowkit/cli validate
+ *   npx @testflowkit/cli --version
+ *
+ * For programmatic usage, you can get the path to the binary:
+ */
+
+const path = require("path");
+const fs = require("fs");
+
+const BINARY_NAME = process.platform === "win32" ? "tkit.exe" : "tkit";
+const binaryPath = path.join(__dirname, "..", "bin", BINARY_NAME);
+
+/**
+ * Get the path to the tkit binary
+ * @returns {string} Absolute path to the tkit binary
+ * @throws {Error} If the binary is not found
+ */
+function getBinaryPath() {
+  if (!fs.existsSync(binaryPath)) {
+    throw new Error(
+      `tkit binary not found. Please reinstall @testflowkit/cli`
+    );
+  }
+  return binaryPath;
+}
+
+/**
+ * Check if the binary is installed
+ * @returns {boolean} True if the binary exists
+ */
+function isInstalled() {
+  return fs.existsSync(binaryPath);
+}
+
+module.exports = {
+  getBinaryPath,
+  isInstalled,
+  binaryPath,
+};

package/lib/install.js

@@ -0,0 +1,170 @@
+#!/usr/bin/env node
+
+const https = require("https");
+const fs = require("fs");
+const path = require("path");
+const AdmZip = require("adm-zip");
+
+const PACKAGE_JSON = require("../package.json");
+const VERSION = PACKAGE_JSON.version;
+const BINARY_NAME = "tkit";
+const GITHUB_RELEASE_URL = `https://github.com/TestFlowKit/testflowkit/releases/download/${VERSION}`;
+
+// Platform and architecture mapping from Node.js to Go naming conventions
+const PLATFORM_MAP = {
+  darwin: "darwin",
+  linux: "linux",
+  win32: "windows",
+};
+
+const ARCH_MAP = {
+  x64: "amd64",
+  arm64: "arm64",
+};
+
+/**
+ * Get the binary name for the current platform
+ */
+function getBinaryName() {
+  return process.platform === "win32" ? `${BINARY_NAME}.exe` : BINARY_NAME;
+}
+
+/**
+ * Get the download URL for the current platform and architecture
+ */
+function getDownloadUrl() {
+  const platform = PLATFORM_MAP[process.platform];
+  const arch = ARCH_MAP[process.arch];
+
+  if (!platform) {
+    throw new Error(`Unsupported platform: ${process.platform}`);
+  }
+
+  if (!arch) {
+    throw new Error(`Unsupported architecture: ${process.arch}`);
+  }
+
+  const filename = `${BINARY_NAME}-${platform}-${arch}.zip`;
+  return `${GITHUB_RELEASE_URL}/${filename}`;
+}
+
+/**
+ * Follow redirects and download file
+ */
+function downloadFile(url, maxRedirects = 5) {
+  return new Promise((resolve, reject) => {
+    if (maxRedirects === 0) {
+      reject(new Error("Too many redirects"));
+      return;
+    }
+
+    const protocol = url.startsWith("https") ? https : require("http");
+
+    protocol
+      .get(url, (response) => {
+        // Handle redirects (GitHub releases use redirects)
+        if (
+          response.statusCode >= 300 &&
+          response.statusCode < 400 &&
+          response.headers.location
+        ) {
+          downloadFile(response.headers.location, maxRedirects - 1)
+            .then(resolve)
+            .catch(reject);
+          return;
+        }
+
+        if (response.statusCode !== 200) {
+          reject(
+            new Error(`Failed to download: HTTP ${response.statusCode}`)
+          );
+          return;
+        }
+
+        const chunks = [];
+        response.on("data", (chunk) => chunks.push(chunk));
+        response.on("end", () => resolve(Buffer.concat(chunks)));
+        response.on("error", reject);
+      })
+      .on("error", reject);
+  });
+}
+
+/**
+ * Extract zip file using adm-zip (cross-platform, no OS dependency)
+ */
+async function extractZip(zipBuffer, destDir) {
+  try {
+    const zip = new AdmZip(zipBuffer);
+    zip.extractAllTo(destDir, true);
+  } catch (error) {
+    throw new Error(`Failed to extract zip: ${error.message}`);
+  }
+}
+
+/**
+ * Make the binary executable (Unix only)
+ */
+function makeExecutable(filePath) {
+  if (process.platform !== "win32") {
+    fs.chmodSync(filePath, 0o755);
+  }
+}
+
+/**
+ * Main installation function
+ */
+async function install() {
+  const binDir = path.join(__dirname, "..", "bin");
+  const binaryName = getBinaryName();
+  const binaryPath = path.join(binDir, binaryName);
+
+  // Check if binary already exists
+  if (fs.existsSync(binaryPath)) {
+    console.log(`✓ ${BINARY_NAME} binary already exists`);
+    return;
+  }
+
+  // Ensure bin directory exists
+  if (!fs.existsSync(binDir)) {
+    fs.mkdirSync(binDir, { recursive: true });
+  }
+
+  const downloadUrl = getDownloadUrl();
+  console.log(`Downloading ${BINARY_NAME} v${VERSION}...`);
+  console.log(`  Platform: ${process.platform} (${PLATFORM_MAP[process.platform]})`);
+  console.log(`  Architecture: ${process.arch} (${ARCH_MAP[process.arch]})`);
+  console.log(`  URL: ${downloadUrl}`);
+
+  try {
+    // Download the zip file
+    const zipBuffer = await downloadFile(downloadUrl);
+    console.log(`Downloaded ${(zipBuffer.length / 1024 / 1024).toFixed(2)} MB`);
+
+    // Extract to bin directory
+    console.log("Extracting...");
+    await extractZip(zipBuffer, binDir);
+
+    // Make executable
+    makeExecutable(binaryPath);
+
+    // Verify installation
+    if (fs.existsSync(binaryPath)) {
+      console.log(`✓ Successfully installed ${BINARY_NAME} v${VERSION}`);
+    } else {
+      throw new Error("Binary not found after extraction");
+    }
+  } catch (error) {
+    console.error(`✗ Failed to install ${BINARY_NAME}: ${error.message}`);
+    console.error("");
+    console.error("You can manually download the binary from:");
+    console.error(GITHUB_RELEASE_URL);
+    console.error("");
+    console.error("Then place it in:");
+    console.error(`  ${binDir}`);
+    process.exit(1);
+  }
+}
+
+// Run installation
+install();

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@testflowkit/cli",
+  "version": "2.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "TestFlowKit CLI - A powerful end-to-end testing framework using Gherkin syntax",
+  "main": "lib/index.js",
+  "bin": {
+    "tkit": "./bin/tkit"
+  },
+  "scripts": {
+    "postinstall": "node ./lib/install.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TestFlowKit/testflowkit.git"
+  },
+  "keywords": [
+    "testflowkit",
+    "testing",
+    "e2e",
+    "end-to-end",
+    "gherkin",
+    "cucumber",
+    "bdd",
+    "cli",
+    "automation"
+  ],
+  "author": "TestFlowKit",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/TestFlowKit/testflowkit/issues"
+  },
+  "homepage": "https://github.com/TestFlowKit/testflowkit#readme",
+  "os": [
+    "darwin",
+    "linux",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "dependencies": {
+    "adm-zip": "^0.5.10"
+  },
+  "files": [
+    "bin",
+    "lib/install.js",
+    "lib/index.js",
+    "README.md"
+  ]
+}