create-flaghoist 0.2.2 → 0.3.1

package/dist/index.js

@@ -1,21 +1,21 @@
 #!/usr/bin/env node
 
 // src/index.ts
-import { PLATFORM_KINDS as PLATFORM_KINDS2, STORAGE_KINDS as STORAGE_KINDS2 } from "flaghoist";
-import { parseArgs } from "util";
+import { PLATFORM_KINDS as PLATFORM_KINDS2, setupSummary, STORAGE_KINDS as STORAGE_KINDS2, terminalAsker } from "flaghoist";
 import { relative } from "path";
+import { parseArgs } from "util";
 
 // src/scaffold.ts
 import {
-  asContainer,
-  DEFAULT_CONFIG,
+  collectSetup,
+  defaultsAsker,
   PLATFORM_KINDS,
-  serializeConfig,
-  STORAGE_KINDS
+  STORAGE_KINDS,
+  writeSetup
 } from "flaghoist";
-import { existsSync, mkdirSync, readdirSync, writeFileSync } from "fs";
-import { join, resolve } from "path";
-function scaffold(options = {}) {
+import { existsSync, mkdirSync, readdirSync } from "fs";
+import { basename, join, resolve } from "path";
+async function scaffold(options = {}) {
   const root = options.cwd ?? process.cwd();
   if (options.storage && !STORAGE_KINDS.includes(options.storage)) {
     throw new Error(`Unknown storage "${options.storage}". One of: ${STORAGE_KINDS.join(", ")}.`);
@@ -23,72 +23,121 @@ function scaffold(options = {}) {
   if (options.platform && !PLATFORM_KINDS.includes(options.platform)) {
     throw new Error(`Unknown platform "${options.platform}". One of: ${PLATFORM_KINDS.join(", ")}.`);
   }
-  const dir = options.directory ? resolve(root, options.directory) : resolve(root);
+  if (options.directory) assertUsable(resolve(root, options.directory), options.directory);
+  else if (!options.asker?.interactive) assertUsable(resolve(root), void 0);
+  const { directory, cwd: _cwd, asker, storage, platform, ...rest } = options;
+  const preset = {
+    ...rest,
+    storage,
+    platform,
+    // The directory name is the natural project name.
+    name: rest.name ?? (directory ? basename(directory) : void 0)
+  };
+  const setup = await collectSetup(asker ?? defaultsAsker(), preset);
+  const target = directory ?? (asker?.interactive === false || !asker ? void 0 : setup.config.name);
+  const dir = target ? resolve(root, target) : resolve(root);
+  assertUsable(dir, target);
   const existed = existsSync(dir);
-  if (existed && readdirSync(dir).length > 0) {
+  if (!existed) mkdirSync(dir, { recursive: true });
+  const { envPath } = writeSetup(dir, setup);
+  return {
+    dir,
+    configPath: join(dir, "flaghoist.toml"),
+    ...envPath ? { envPath } : {},
+    createdDirectory: !existed,
+    config: setup.config,
+    setup
+  };
+}
+function assertUsable(dir, shown) {
+  if (existsSync(dir) && readdirSync(dir).length > 0) {
     throw new Error(
-      options.directory ? `Directory "${options.directory}" already exists and is not empty.` : "The current directory is not empty. Pass a directory name, e.g. `npm create flaghoist team-flags`."
+      shown ? `Directory "${shown}" already exists and is not empty.` : "The current directory is not empty. Pass a directory name, e.g. `npm create flaghoist team-flags`."
     );
   }
-  if (!existed) mkdirSync(dir, { recursive: true });
-  const base = {
-    ...DEFAULT_CONFIG,
-    // The directory name is the natural project name; falling back keeps `.` usable.
-    name: options.directory ?? DEFAULT_CONFIG.name,
-    storage: options.storage ?? DEFAULT_CONFIG.storage
-  };
-  const config = options.platform === "container" ? asContainer(base) : base;
-  const configPath = join(dir, "flaghoist.toml");
-  writeFileSync(configPath, serializeConfig(config));
-  return { dir, configPath, createdDirectory: !existed, config };
 }
 
 // src/index.ts
 function printHelp() {
-  console.log(`create-flaghoist \u2014 scaffold a Flaghoist feature-flag service
+  console.log(`create-flaghoist: set up a Flaghoist feature-flag service
 
 Usage:
-  npm create flaghoist@latest <directory> [--storage <kind>] [--platform <kind>]
+  npm create flaghoist@latest [directory] -- [options]
+
+With no options it asks a few questions. Any option below answers its question up front.
 
 Options:
-  --storage    One of: ${STORAGE_KINDS2.join(", ")}  (default: ${STORAGE_KINDS2[0]})
-  --platform   One of: ${PLATFORM_KINDS2.join(", ")}  (default: ${PLATFORM_KINDS2[0]})
-  -h, --help   Show this message
+  --name <name>             Project name (default: the directory, or team-flags)
+  --platform <kind>         One of: ${PLATFORM_KINDS2.join(", ")}
+  --storage <kind>          One of: ${STORAGE_KINDS2.join(", ")}
+  --no-accounts             Keep the single admin token, without accounts and roles
+  --sso-issuer <url>        Turn on SSO with this OpenID Connect issuer
+  --sso-client-id <id>      The SSO client id
+  --sso-admin-group <name>  Members of this group become admins
+  --no-dashboard            Do not serve the dashboard at /admin
+  -y, --yes                 Take the defaults for everything not given
+  -h, --help                Show this message
 
-Omit <directory> to scaffold into the current directory (it must be empty).`);
+Omit [directory] to be asked for a project name; it becomes the directory.`);
 }
-function main() {
+async function main() {
   const { values, positionals } = parseArgs({
     args: process.argv.slice(2),
     allowPositionals: true,
     options: {
+      name: { type: "string" },
       storage: { type: "string" },
       platform: { type: "string" },
+      "no-accounts": { type: "boolean" },
+      "sso-issuer": { type: "string" },
+      "sso-client-id": { type: "string" },
+      "sso-admin-group": { type: "string" },
+      "no-dashboard": { type: "boolean" },
+      yes: { type: "boolean", short: "y" },
       help: { type: "boolean", short: "h" }
     }
   });
   if (values.help) return printHelp();
-  const { dir, configPath, config } = scaffold({
+  const interactive = process.stdin.isTTY === true && values.yes !== true;
+  const asker = interactive ? terminalAsker() : void 0;
+  if (interactive) console.log("\nLet us set up your Flaghoist service.\n");
+  const options = {
     directory: positionals[0],
+    name: values.name,
     storage: values.storage,
-    platform: values.platform
-  });
-  const shown = relative(process.cwd(), configPath) || "flaghoist.toml";
+    platform: values.platform,
+    ...values["no-accounts"] ? { accounts: false } : {},
+    ...values["no-dashboard"] ? { dashboard: false } : {},
+    ...values["sso-issuer"] ? { ssoIssuer: values["sso-issuer"] } : {},
+    ...values["sso-client-id"] ? { ssoClientId: values["sso-client-id"] } : {},
+    ...values["sso-admin-group"] ? { ssoAdminGroup: values["sso-admin-group"] } : {},
+    asker
+  };
+  let result;
+  try {
+    result = await scaffold(options);
+  } finally {
+    asker?.close();
+  }
+  const shown = relative(process.cwd(), result.configPath) || "flaghoist.toml";
   console.log(`
 Created ${shown}`);
-  console.log(`  name      ${config.name}`);
-  console.log(`  storage   ${config.storage}`);
-  console.log(`  platform  ${config.platform}
-`);
-  console.log("That file is the entire project. Next:\n");
-  const cd = relative(process.cwd(), dir);
+  const summary = setupSummary(
+    interactive ? result.setup : { ...result.setup, pepperGenerated: false },
+    result.envPath !== void 0
+  );
+  for (const line of summary) console.log(line);
+  console.log("\nNext:\n");
+  const cd = relative(process.cwd(), result.dir);
   if (cd) console.log(`  cd ${cd}`);
   console.log("  npx flaghoist deploy\n");
+  if (result.config.accounts?.enabled) {
+    console.log("After deploying, open /admin and sign in with your ADMIN_TOKEN once to create the");
+    console.log("owner account. Everyone after that is invited from the Members page.\n");
+  }
   console.log("Prefer to own the code? `npx flaghoist eject` turns it into a project you edit.");
 }
-try {
-  main();
-} catch (error) {
+main().catch((error) => {
   console.error(error instanceof Error ? error.message : String(error));
   process.exit(1);
-}
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-flaghoist",
-  "version": "0.2.2",
+  "version": "0.3.1",
   "description": "Scaffold a Flaghoist feature-flag service — the package behind `npm create flaghoist`.",
   "license": "Apache-2.0",
   "type": "module",
@@ -21,7 +21,7 @@
     "scaffold"
   ],
   "dependencies": {
-    "flaghoist": "0.4.0"
+    "flaghoist": "0.5.1"
   },
   "publishConfig": {
     "access": "public"