@tailglow/cli 0.9.6 → 0.9.15

package/src/config.js

@@ -71,6 +71,7 @@ export function readCliVersion() {
   version_read ??= fs
     .readFile(join(dirname(fileURLToPath(import.meta.url)), "..", "package.json"), "utf-8")
     .then((manifest) => String(JSON.parse(manifest).version));
+
   return version_read;
 }
 
@@ -87,7 +88,9 @@ export function readCliVersion() {
 export async function loadConfig(path = CLI_CONFIGS.CONFIG_PATH) {
   try {
     const parsed = JSON.parse(await fs.readFile(path, "utf-8"));
+
     if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) return {};
+
     return parsed;
   } catch {
     return {};
@@ -107,15 +110,18 @@ export async function loadConfig(path = CLI_CONFIGS.CONFIG_PATH) {
 export async function loadConfigForWrite(path = CLI_CONFIGS.CONFIG_PATH) {
   /** @type {string} */
   let contents;
+
   try {
     contents = await fs.readFile(path, "utf-8");
   } catch (err) {
     if (/** @type {NodeJS.ErrnoException} */ (err).code === "ENOENT") return {};
+
     throw new Error(`Cannot read ${path}: ${err instanceof Error ? err.message : String(err)}`);
   }
 
   /** @type {unknown} */
   let parsed;
+
   try {
     parsed = JSON.parse(contents);
   } catch {
@@ -148,15 +154,18 @@ export async function loadConfigForWrite(path = CLI_CONFIGS.CONFIG_PATH) {
  */
 export async function saveConfig(values, path = CLI_CONFIGS.CONFIG_PATH) {
   const directory = dirname(path);
+
   await fs.mkdir(directory, { recursive: true, mode: CLI_CONFIGS.DIRECTORY_MODE });
   await fs.chmod(directory, CLI_CONFIGS.DIRECTORY_MODE);
 
   const staged = `${path}.${process.pid}.${Date.now()}.tmp`;
+
   try {
     await fs.writeFile(staged, `${JSON.stringify(values, null, 2)}\n`, {
       mode: CLI_CONFIGS.FILE_MODE,
       flag: "wx"
     });
+
     await fs.chmod(staged, CLI_CONFIGS.FILE_MODE);
     await fs.rename(staged, path);
   } catch (err) {
@@ -197,9 +206,11 @@ export async function withConfigLock(
 ) {
   const lock_path = `${path}.lock`;
   const token = `${process.pid}:${randomUUID()}`;
+
   await fs.mkdir(dirname(path), { recursive: true, mode: CLI_CONFIGS.DIRECTORY_MODE });
 
   const started_at = Date.now();
+
   while (true) {
     try {
       await fs.writeFile(lock_path, token, { flag: "wx", mode: CLI_CONFIGS.FILE_MODE });
@@ -212,6 +223,7 @@ export async function withConfigLock(
             `If no tglow is running, delete ${lock_path} and try again.`
         );
       }
+
       await new Promise((resolve) => setTimeout(resolve, CLI_CONFIGS.LOCK_RETRY_MS));
     }
   }
@@ -233,6 +245,7 @@ export async function withConfigLock(
 export async function updateConfig(mutate, path = CLI_CONFIGS.CONFIG_PATH) {
   return withConfigLock(async () => {
     const next = mutate(await loadConfigForWrite(path));
+
     await saveConfig(next, path);
     return next;
   }, path);
@@ -244,6 +257,7 @@ export async function updateConfig(mutate, path = CLI_CONFIGS.CONFIG_PATH) {
  */
 export function redactSetting(key, value) {
   if (!SECRET_KEYS.has(key)) return value;
+
   return value.length <= 8 ? "********" : `${value.slice(0, 4)}...${value.slice(-4)}`;
 }
 
@@ -260,12 +274,17 @@ function isNonEmptyString(value) {
  */
 export function readStoredLogin(config) {
   const login = config.login;
+
   if (!login || typeof login !== "object" || Array.isArray(login)) return null;
+
   const fields = /** @type {Record<string, unknown>} */ (login);
+
   if (fields.type !== "session" && fields.type !== "api_key") return null;
+
   for (const name of ["secret", "id", "api_url", "team_id", "user_id", "email"]) {
     if (!isNonEmptyString(fields[name])) return null;
   }
+
   return /** @type {import("./types.d.ts").StoredLogin} */ (login);
 }
 
@@ -277,13 +296,19 @@ export function readStoredLogin(config) {
  */
 export function readPendingLogin(config) {
   const pending = config.pending_login;
+
   if (!pending || typeof pending !== "object" || Array.isArray(pending)) return null;
+
   const fields = /** @type {Record<string, unknown>} */ (pending);
+
   if (fields.method !== "account" && fields.method !== "api_key") return null;
+
   for (const name of ["id", "poll_secret", "user_code", "verification_url", "api_url"]) {
     if (!isNonEmptyString(fields[name])) return null;
   }
+
   if (typeof fields.started_at !== "number") return null;
+
   return /** @type {import("./types.d.ts").PendingLogin} */ (pending);
 }
 
@@ -304,12 +329,15 @@ export function readPendingLogin(config) {
  */
 export function resolveSetting(name, { flags = {}, env = process.env, config = {} } = {}) {
   const flag = flags[name.replaceAll("_", "-")] ?? flags[name];
+
   if (typeof flag === "string" && flag.length > 0) return flag;
 
   const from_env = env[`TAILGLOW_${name.toUpperCase()}`];
+
   if (typeof from_env === "string" && from_env.length > 0) return from_env;
 
   const stored = config[name];
+
   return typeof stored === "string" && stored.length > 0 ? stored : null;
 }
 
@@ -355,18 +383,22 @@ export function isSameApiUrl(first, second) {
  */
 export function resolveCredential({ flags = {}, env = process.env, config = {} } = {}) {
   const flag = flags["api-key"];
+
   if (isNonEmptyString(flag)) return { secret: String(flag), source: "flag", login: null };
 
   const from_env = env.TAILGLOW_API_KEY;
+
   if (isNonEmptyString(from_env)) return { secret: String(from_env), source: "env", login: null };
 
   const login = readStoredLogin(config);
   const api_url = resolveApiUrl({ flags, env, config });
+
   if (login && isSameApiUrl(login.api_url, api_url)) {
     return { secret: login.secret, source: "login", login };
   }
 
   const stored = config.api_key;
+
   if (isNonEmptyString(stored)) return { secret: String(stored), source: "config", login: null };
 
   if (login) {
@@ -376,6 +408,7 @@ export function resolveCredential({ flags = {}, env = process.env, config = {} }
         `${api_url}\`.`
     );
   }
+
   throw new Error(
     "Not signed in. Run `tglow login`, or set TAILGLOW_API_KEY to an API key.\n" +
       "Create a key in the dashboard under Team settings."

package/src/docs-command.js

@@ -28,11 +28,13 @@ export function toDocsPath(reference) {
 /** @param {string} path */
 function findSimilarPaths(path) {
   const name = (path.split("/").pop() ?? path).toLowerCase();
+
   if (!name) return [];
 
   return Object.keys(DOCS_PAGES)
     .filter((candidate) => {
       const candidate_name = (candidate.split("/").pop() ?? candidate).toLowerCase();
+
       return candidate_name.includes(name) || name.includes(candidate_name);
     })
     .slice(0, 5);
@@ -70,12 +72,14 @@ export function runDocsCommand(words, flags) {
   const json = Boolean(flags.json);
 
   const unknown = Object.keys(flags).filter((flag) => !RESERVED_FLAGS.has(flag));
+
   if (unknown.length > 0) {
     return fail(
       `Unknown flag${unknown.length === 1 ? "" : "s"}: ${unknown.map((flag) => `--${flag}`).join(", ")}.`,
       json
     );
   }
+
   if (rest.length > 0) {
     return fail(`Unexpected argument${rest.length === 1 ? "" : "s"}: ${rest.join(", ")}.`, json);
   }
@@ -129,10 +133,12 @@ export function runDocsCommand(words, flags) {
       similar.length > 0
         ? ` Did you mean ${similar.map((candidate) => `\`${candidate}\``).join(", ")}?`
         : "";
+
     return fail(`No docs page "${reference}".${hint} Run \`tglow docs\` for the index.`, json);
   }
 
   const url = `${CLI_CONFIGS.DOCS_URL}/${path}.md`;
+
   if (json) return { output: JSON.stringify({ path, url, content }, null, 2), code: 0 };
 
   return { output: `${content.trimEnd()}\n\nLatest version online: ${url}`, code: 0 };