flaghoist 0.1.0 → 0.1.2

package/README.md

@@ -0,0 +1,52 @@
+# flaghoist
+
+Feature flags you run yourself. This is the command line tool for setting up a Flaghoist server and
+managing the flags on it.
+
+Your whole project is one `flaghoist.toml` file. The CLI turns that into a Cloudflare Worker, or
+hands you the code if you would rather own it.
+
+```bash
+npm create flaghoist@latest team-flags
+cd team-flags
+npx flaghoist deploy
+```
+
+That gives you an OFREP read API, an admin API, and a dashboard at `/admin`, all from a single
+deploy. On Cloudflare KV, the first deploy also creates the KV namespace for you and writes its id
+into `wrangler.toml`.
+
+## Managing flags
+
+Point the CLI at your server with `--url` and `--token`, or set `FLAGS_URL` and
+`FLAGS_ADMIN_TOKEN`.
+
+```bash
+flaghoist flag list
+flaghoist flag create new-checkout --desc "The redesigned checkout"
+flaghoist flag toggle new-checkout --on
+flaghoist flag rollout new-checkout 25
+```
+
+Rollouts are sticky. A user who lands inside 25 percent stays inside it as you go to 50, so nobody
+flickers in and out between deploys.
+
+## Owning the code
+
+```bash
+npx flaghoist eject
+```
+
+Writes `src/index.ts`, `wrangler.toml` and `package.json` into your project. From there it is a
+normal Worker and the CLI steps out of the way.
+
+Flags are boolean only. There are no multivariate flags, experiments or scheduled rules, and there
+is no plan to imply otherwise.
+
+## Status
+
+Pre-alpha, built and maintained by one person. The API can still change without notice, and
+production use is not recommended yet. If you try it and something breaks, an issue is genuinely
+useful.
+
+Apache-2.0. Part of [Flaghoist](https://github.com/flaghoist/flaghoist).

package/dist/index.js

@@ -164,7 +164,7 @@ function generateWranglerToml(config) {
   if (config.storage === "cloudflare-kv") {
     lines.push(
       "",
-      "# Created for you by `flaghoist deploy`, or by: npx wrangler kv namespace create FLAGS",
+      `# Created for you by \`flaghoist deploy\`, or by: npx wrangler kv namespace create ${config.name}-FLAGS`,
       "kv_namespaces = [",
       `  { binding = "FLAGS", id = ${JSON.stringify(KV_NAMESPACE_PLACEHOLDER)} }`,
       "]"
@@ -343,7 +343,7 @@ function runEject() {
   console.log("Ejected to a code project you own: src/index.ts, wrangler.toml, package.json");
   if (config.storage === "cloudflare-kv") {
     console.log("Create your KV namespace and paste the id into wrangler.toml:");
-    console.log("  npx wrangler kv namespace create FLAGS");
+    console.log(`  npx wrangler kv namespace create ${config.name}-FLAGS`);
   }
   console.log("Edit src/index.ts freely, then: npm install && npx wrangler deploy");
 }
@@ -351,8 +351,9 @@ function ensureKvNamespace(config) {
   if (config.storage !== "cloudflare-kv") return;
   const toml = readFileSync("wrangler.toml", "utf8");
   if (!needsKvNamespace(toml)) return;
-  console.log("Creating the FLAGS KV namespace...");
-  const created = spawnSync("npx", ["wrangler", "kv", "namespace", "create", "FLAGS"], {
+  const title = `${config.name}-FLAGS`;
+  console.log(`Creating the ${title} KV namespace...`);
+  const created = spawnSync("npx", ["wrangler", "kv", "namespace", "create", title], {
     stdio: ["inherit", "pipe", "inherit"],
     encoding: "utf8"
   });
@@ -360,7 +361,7 @@ function ensureKvNamespace(config) {
   if (output) process.stdout.write(output);
   if (created.status !== 0) {
     throw new Error(
-      "Could not create the KV namespace. Run `npx wrangler kv namespace create FLAGS` yourself, then paste the id into wrangler.toml."
+      `Could not create the KV namespace. Run \`npx wrangler kv namespace create ${title}\` yourself, then paste the id into wrangler.toml.`
     );
   }
   const id = parseKvNamespaceId(output);
@@ -372,9 +373,18 @@ function ensureKvNamespace(config) {
   writeFileSync("wrangler.toml", fillKvNamespaceId(toml, id));
   console.log(`Bound FLAGS to namespace ${id} in wrangler.toml`);
 }
+function ensureDependencies() {
+  if (existsSync("node_modules")) return;
+  console.log("Installing dependencies...");
+  const result = spawnSync("npm", ["install", "--no-audit", "--no-fund"], { stdio: "inherit" });
+  if (result.status !== 0) {
+    throw new Error("`npm install` failed. Run it yourself, then `flaghoist deploy` again.");
+  }
+}
 function runDeploy() {
   const config = loadConfig();
   if (!existsSync("src/index.ts")) writeProject(config, ".");
+  ensureDependencies();
   ensureKvNamespace(config);
   console.log("Deploying with wrangler...");
   const result = spawnSync("npx", ["wrangler", "deploy"], { stdio: "inherit" });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flaghoist",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Scaffold, deploy, and manage your Flaghoist feature-flag service from the terminal.",
   "license": "Apache-2.0",
   "type": "module",
@@ -26,13 +26,31 @@
     "smol-toml": "^1.7.1"
   },
   "devDependencies": {
-    "@flaghoist/adapter-memory": "0.1.0",
-    "@flaghoist/core": "0.1.0",
-    "@flaghoist/server": "0.1.0"
+    "@flaghoist/adapter-memory": "0.1.1",
+    "@flaghoist/core": "0.1.1",
+    "@flaghoist/server": "0.1.1"
   },
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "feature-flags",
+    "feature-toggles",
+    "openfeature",
+    "ofrep",
+    "cloudflare-workers",
+    "self-hosted",
+    "cli"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/flaghoist/flaghoist.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://github.com/flaghoist/flaghoist#readme",
+  "bugs": {
+    "url": "https://github.com/flaghoist/flaghoist/issues"
+  },
   "scripts": {
     "build": "tsup src/index.ts src/lib.ts --format esm --dts --clean",
     "test": "vitest run --passWithNoTests",