@fourtwelvelabs/fetch-contentful 0.4.0 → 1.0.0

package/dist/cli/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { mkdirSync, writeFileSync, existsSync, readFileSync } from 'fs';
+import { existsSync, readFileSync, mkdirSync, writeFileSync } from 'fs';
 import { resolve, dirname, relative, isAbsolute, sep, join } from 'path';
 import { getIntrospectionQuery, printSchema, buildClientSchema } from 'graphql';
 
@@ -13,7 +13,6 @@ function readEnvSettings() {
       space: void 0,
       environment: void 0,
       deliveryToken: void 0,
-      token: void 0,
       previewToken: void 0
     };
   }
@@ -28,7 +27,6 @@ function readEnvSettings() {
       process.env.CONTENTFUL_ENVIRONMENT || process.env.NEXT_PUBLIC_CONTENTFUL_ENVIRONMENT
     ),
     deliveryToken,
-    token: deliveryToken,
     // No `NEXT_PUBLIC_` fallback: see the note at the top of this file.
     previewToken: orUndefined(process.env.CONTENTFUL_PREVIEW_ACCESS_TOKEN)
   };
@@ -53,7 +51,8 @@ var VALUE_FLAGS = [
   "tada-output",
   "graphql-file",
   "tsconfig",
-  "cwd"
+  "cwd",
+  "env-file"
 ];
 function isBooleanFlag(name) {
   return BOOLEAN_FLAGS.includes(name);
@@ -158,6 +157,53 @@ function formatBytes(bytes) {
   if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} kB`;
   return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
 }
+var ENV_FILES = [".env.local", ".env"];
+var ASSIGNMENT = /^(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*)$/;
+function parseEnvFile(source) {
+  const values = {};
+  for (const rawLine of source.split(/\r?\n/)) {
+    const line = rawLine.trim();
+    if (line === "" || line.startsWith("#")) continue;
+    const match = ASSIGNMENT.exec(line);
+    if (!match) continue;
+    const key = match[1];
+    let value = match[2].trim();
+    const quote = value[0];
+    if ((quote === '"' || quote === "'") && value.length > 1 && value.endsWith(quote)) {
+      value = value.slice(1, -1);
+      if (quote === '"') value = value.replace(/\\n/g, "\n");
+    } else {
+      const comment = value.search(/\s#/);
+      if (comment !== -1) value = value.slice(0, comment).trimEnd();
+    }
+    values[key] = value;
+  }
+  return values;
+}
+function loadEnvFiles(directory, explicit) {
+  const load = { directory, files: [], applied: [] };
+  if (explicit !== void 0 && !existsSync(resolve(directory, explicit))) {
+    throw new CliError(`No env file at ${explicit}.`);
+  }
+  for (const candidate of explicit === void 0 ? ENV_FILES : [explicit]) {
+    const path = resolve(directory, candidate);
+    if (!existsSync(path)) continue;
+    load.files.push(candidate);
+    for (const [key, value] of Object.entries(parseEnvFile(readFileSync(path, "utf8")))) {
+      if (!process.env[key]) {
+        process.env[key] = value;
+        load.applied.push(key);
+      }
+    }
+  }
+  return load;
+}
+function describeEnvFiles(load) {
+  if (load.files.length === 0) {
+    return `No ${ENV_FILES.join(" or ")} file was found in ${load.directory}, so only the shell environment was read. Point at one with --env-file if it lives elsewhere.`;
+  }
+  return `Read ${load.files.join(" and ")}; anything already set in the environment takes precedence over them.`;
+}
 var PACKAGE_NAME = "@fourtwelvelabs/fetch-contentful";
 function relativeSpecifier(fromFile, toFile) {
   const path = relative(dirname(fromFile), toFile).split(sep).join("/");
@@ -212,26 +258,19 @@ async function fetchSchemaSdl(options) {
     });
   } catch (cause) {
     throw new CliError(
-      `Could not reach Contentful at ${url}: ${redact(
-        String(cause),
-        options.token
-      )}`
+      `Could not reach Contentful at ${url}: ${redact(String(cause), options.token)}`
     );
   }
   if (response.status === 401 || response.status === 403) {
     throw new CliError(
-      `Contentful rejected the access token (HTTP ${String(
-        response.status
-      )}).
+      `Contentful rejected the access token (HTTP ${String(response.status)}).
   Check that the token is a Content Delivery API token for space "${options.space}", and that it has access to environment "${options.environment}".`
     );
   }
   if (!response.ok) {
     const body = bodySnippet(await response.text().catch(() => ""), options.token);
-    throw new CliError(
-      `Contentful responded with HTTP ${String(response.status)}.
-  ${body}`
-    );
+    throw new CliError(`Contentful responded with HTTP ${String(response.status)}.
+  ${body}`);
   }
   let payload;
   try {
@@ -242,10 +281,7 @@ async function fetchSchemaSdl(options) {
   if (payload.errors && payload.errors.length > 0) {
     const messages = payload.errors.map((error) => error.message ?? "unknown error").join("; ");
     throw new CliError(
-      `Contentful returned GraphQL errors during introspection: ${redact(
-        messages,
-        options.token
-      )}`
+      `Contentful returned GraphQL errors during introspection: ${redact(messages, options.token)}`
     );
   }
   if (!payload.data) {
@@ -258,9 +294,7 @@ async function fetchSchemaSdl(options) {
 `;
   } catch (cause) {
     throw new CliError(
-      `Could not build a schema from Contentful's introspection response: ${String(
-        cause
-      )}`
+      `Could not build a schema from Contentful's introspection response: ${String(cause)}`
     );
   }
 }
@@ -293,9 +327,7 @@ function installCommand(manager, packages) {
 function missingDependencies(cwd, packages) {
   let manifest;
   try {
-    manifest = JSON.parse(
-      readFileSync(join(cwd, "package.json"), "utf8")
-    );
+    manifest = JSON.parse(readFileSync(join(cwd, "package.json"), "utf8"));
   } catch {
     return [...packages];
   }
@@ -356,9 +388,7 @@ var Scanner = class {
   }
   expect(character) {
     if (this.peek() !== character) {
-      throw new JsoncError(
-        `Expected "${character}" at offset ${String(this.index)}.`
-      );
+      throw new JsoncError(`Expected "${character}" at offset ${String(this.index)}.`);
     }
     this.index += 1;
   }
@@ -366,9 +396,7 @@ var Scanner = class {
     const node = this.parseValue();
     this.skipTrivia();
     if (this.index !== this.source.length) {
-      throw new JsoncError(
-        `Unexpected trailing content at offset ${String(this.index)}.`
-      );
+      throw new JsoncError(`Unexpected trailing content at offset ${String(this.index)}.`);
     }
     return node;
   }
@@ -488,9 +516,7 @@ function renderPluginEntry(indent, unit, config) {
     "{",
     `${indent}${unit}"name": ${JSON.stringify(GRAPHQLSP_PLUGIN)},`,
     `${indent}${unit}"schema": ${JSON.stringify(config.schema)},`,
-    `${indent}${unit}"tadaOutputLocation": ${JSON.stringify(
-      config.tadaOutputLocation
-    )}`,
+    `${indent}${unit}"tadaOutputLocation": ${JSON.stringify(config.tadaOutputLocation)}`,
     `${indent}}`
   ].join("\n");
 }
@@ -518,11 +544,7 @@ ${closeIndent}`
 function renderPluginsArray(indent, unit, config) {
   const entryIndent = `${indent}${unit}`;
   return `[
-${entryIndent}${renderPluginEntry(
-    entryIndent,
-    unit,
-    config
-  )}
+${entryIndent}${renderPluginEntry(entryIndent, unit, config)}
 ${indent}]`;
 }
 function patchTsconfig(source, config) {
@@ -592,9 +614,7 @@ ${indent}}`,
           text: JSON.stringify(value)
         });
       } else {
-        edits.push(
-          insertMember(source, existing, key, () => JSON.stringify(value), unit)
-        );
+        edits.push(insertMember(source, existing, key, () => JSON.stringify(value), unit));
       }
     }
     const patched = applyEdits(source, edits);
@@ -624,11 +644,7 @@ ${indent}${renderPluginEntry(indent, unit, config)}`
         start: plugins.value.start + 1,
         end: plugins.value.end - 1,
         text: `
-${entryIndent}${renderPluginEntry(
-          entryIndent,
-          unit,
-          config
-        )}
+${entryIndent}${renderPluginEntry(entryIndent, unit, config)}
 ${closeIndent}`
       }
     ])
@@ -668,11 +684,14 @@ Other:
   --dry-run               Show what would change; write nothing
   --force                 Overwrite an existing graphql file (tada-init)
   --cwd <path>            Run against another directory
+  --env-file <path>       Read this file instead of .env.local / .env
   -h, --help              Show this help
 
-The NEXT_PUBLIC_-prefixed variable names are read as fallbacks, exactly as
-the library reads them at runtime.`;
-function resolveConfig(args) {
+Configuration is read from .env.local, then .env, then the shell \u2014 anything
+already exported wins over a file, and flags win over everything. The
+NEXT_PUBLIC_-prefixed names are accepted as fallbacks, exactly as the
+library reads them at runtime.`;
+function resolveConfig(args, envFiles) {
   const env = readEnvSettings();
   const space = args.values.space ?? env.space;
   const token = args.values.token ?? env.deliveryToken;
@@ -693,7 +712,8 @@ function resolveConfig(args) {
       `Missing required Contentful configuration:
   - ${missing.join(
         "\n  - "
-      )}`
+      )}
+${describeEnvFiles(envFiles)}`
     );
   }
   return { space, environment, token };
@@ -760,9 +780,7 @@ function planTsconfig(paths) {
 }
 function planGraphqlModule(paths, force) {
   const before = readIfExists(paths.graphqlFile);
-  const after = renderGraphqlModule(
-    relativeSpecifier(paths.graphqlFile, paths.tadaOutput)
-  );
+  const after = renderGraphqlModule(relativeSpecifier(paths.graphqlFile, paths.tadaOutput));
   if (before !== void 0 && !force) {
     return {
       kind: "skip",
@@ -829,9 +847,7 @@ function apply(action) {
 function reportManual(action, paths, io) {
   if (action.kind !== "manual") return;
   io.stdout("");
-  io.stdout(
-    `${display(paths.root, action.path)} was left untouched because ${action.reason}.`
-  );
+  io.stdout(`${display(paths.root, action.path)} was left untouched because ${action.reason}.`);
   io.stdout('Add this entry to "compilerOptions.plugins" by hand:');
   io.stdout("");
   for (const line of action.block.split("\n")) io.stdout(`  ${line}`);
@@ -844,8 +860,9 @@ function reportPeers(paths, io) {
   io.stdout(`  ${installCommand(detectPackageManager(paths.root), missing)}`);
 }
 async function tadaInit(args, io) {
-  const config = resolveConfig(args);
   const paths = resolvePaths(args, io);
+  const envFiles = loadEnvFiles(paths.root, args.values["env-file"]);
+  const config = resolveConfig(args, envFiles);
   const dryRun = args.flags.has("dry-run");
   const tsconfigAction = planTsconfig(paths);
   const sdl = await fetchSchemaSdl({ ...config, fetch: io.fetch });
@@ -868,32 +885,23 @@ async function tadaInit(args, io) {
   io.stdout("Next steps:");
   io.stdout(`  1. Restart the TypeScript server so ${GRAPHQLSP_PLUGIN} loads.`);
   io.stdout(
-    `  2. Write a query with the \`graphql\` helper from ${display(
-      paths.root,
-      paths.graphqlFile
-    )},`
-  );
-  io.stdout(
-    `     then pass it to fetchContentful from ${PACKAGE_NAME}.`
+    `  2. Write a query with the \`graphql\` helper from ${display(paths.root, paths.graphqlFile)},`
   );
+  io.stdout(`     then pass it to fetchContentful from ${PACKAGE_NAME}.`);
   io.stdout("     Result and variable types are inferred from the document.");
-  io.stdout(
-    "  3. After a content-model change, run `fetch-contentful tada-refresh`."
-  );
+  io.stdout("  3. After a content-model change, run `fetch-contentful tada-refresh`.");
   return 0;
 }
 async function tadaRefresh(args, io) {
-  const config = resolveConfig(args);
   const paths = resolvePaths(args, io);
+  const envFiles = loadEnvFiles(paths.root, args.values["env-file"]);
+  const config = resolveConfig(args, envFiles);
   const dryRun = args.flags.has("dry-run");
   const sdl = await fetchSchemaSdl({ ...config, fetch: io.fetch });
   const action = planSchema(sdl, paths);
   if (action.kind === "unchanged") {
     io.stdout(
-      `Schema is already up to date \u2014 ${display(
-        paths.root,
-        paths.schema
-      )} left untouched.`
+      `Schema is already up to date \u2014 ${display(paths.root, paths.schema)} left untouched.`
     );
     return 0;
   }
@@ -918,10 +926,7 @@ async function dispatch(argv, io) {
 }
 function knownTokens(argv) {
   const env = readEnvSettings();
-  const tokens = [
-    env.deliveryToken,
-    env.previewToken
-  ];
+  const tokens = [env.deliveryToken, env.previewToken];
   for (const [index, argument] of argv.entries()) {
     if (argument.startsWith("--token=")) tokens.push(argument.slice(8));
     else if (argument === "--token") tokens.push(argv[index + 1]);