faces-cli 1.8.3 → 1.8.5

package/dist/catalog.js

@@ -2,14 +2,9 @@ import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
 import { loadConfig } from './config.js';
+import { MAX_FRONTMATTER_VALUE, quoteYaml, unquoteYaml } from './utils.js';
 export const CATALOG_DIR = path.join(os.homedir(), '.faces', 'catalog');
 export const CATALOG_INDEX = path.join(os.homedir(), '.faces', 'catalog.json');
-function quoteYaml(value) {
-    if (/[:#\[\]{}&*!|>'"%@`\n]/.test(value) || value !== value.trim() || value === '') {
-        return `"${value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
-    }
-    return value;
-}
 function serializeFrontmatter(fm) {
     const lines = ['---'];
     lines.push(`name: ${quoteYaml(fm.name)}`);
@@ -57,8 +52,7 @@ function parseFrontmatter(content) {
             const colonIdx = line.indexOf(':');
             if (colonIdx > 0) {
                 const k = line.slice(0, colonIdx).trim();
-                const v = line.slice(colonIdx + 1).trim().replace(/^"(.*)"$/, '$1');
-                attributes[k] = v;
+                attributes[k] = unquoteYaml(line.slice(colonIdx + 1));
             }
             continue;
         }
@@ -67,7 +61,7 @@ function parseFrontmatter(content) {
         if (colonIdx < 0)
             continue;
         const key = line.slice(0, colonIdx).trim();
-        const val = line.slice(colonIdx + 1).trim().replace(/^"(.*)"$/, '$1');
+        const val = unquoteYaml(line.slice(colonIdx + 1));
         if (key === 'name')
             fm.name = val;
         else if (key === 'description')
@@ -137,7 +131,16 @@ export class CatalogService {
                 fm.description = faceData.description;
             }
             else if (existingDescription) {
-                fm.description = existingDescription;
+                // A description this size is corrupt, not long. Carrying it forward is
+                // what kept it alive across writes; dropping it lets the next sync
+                // replace it with the real one.
+                if (existingDescription.length > MAX_FRONTMATTER_VALUE) {
+                    process.stderr.write(`warn: discarded a ${existingDescription.length}-character description on '${alias}' — ` +
+                        'too large to be real. It will be restored from the server on the next sync.\n');
+                }
+                else {
+                    fm.description = existingDescription;
+                }
             }
             if (faceData.default_model)
                 fm.default_model = faceData.default_model;

package/dist/commands/catalog/doctor.js

@@ -4,6 +4,7 @@ import { Flags } from '@oclif/core';
 import { BaseCommand } from '../../base.js';
 import { FacesAPIError } from '../../client.js';
 import { loadConfig } from '../../config.js';
+import { unquoteYaml } from '../../utils.js';
 import { CatalogService, CATALOG_DIR } from '../../catalog.js';
 import { TeamCatalogService, TEAMS_DIR, slugifyTeamName } from '../../team-catalog.js';
 import { resolveEndpoint, MESSAGES_ENDPOINT, RESPONSES_ENDPOINT } from '../../routing.js';
@@ -67,7 +68,7 @@ export default class CatalogDoctor extends BaseCommand {
                                 if (ci < 0)
                                     continue;
                                 const k = line.slice(0, ci).trim();
-                                const v = line.slice(ci + 1).trim().replace(/^"(.*)"$/, '$1');
+                                const v = unquoteYaml(line.slice(ci + 1));
                                 if (k === 'name')
                                     fm.name = v;
                                 if (k === 'description')

package/dist/commands/style/revert.js

@@ -3,9 +3,10 @@ import { BaseCommand } from '../../base.js';
 import { FacesAPIError } from '../../client.js';
 import { VERSIONS_PATH } from '../../style.js';
 export default class StyleRevert extends BaseCommand {
-    static description = 'Go back to the style a face had before the last style:make. A face holds one style per medium, so ' +
-        'name which one with --medium when it has more than one. Two versions are kept per medium, so this ' +
-        'goes back exactly one step. It changes how the face writes immediately, so it asks first.';
+    static description = 'Go back to the style a face had before the last style:make. Two versions are kept per medium, so ' +
+        'this is a toggle: running it again returns to where you started. A face holds one style per medium, ' +
+        'so name which one with --medium when it has more than one. It changes how the face writes ' +
+        'immediately, so it asks first.';
     static examples = [
         '<%= config.bin %> <%= command.id %> alice --yes',
         '<%= config.bin %> <%= command.id %> alice --medium email --yes',
@@ -50,13 +51,6 @@ export default class StyleRevert extends BaseCommand {
                 if (err.statusCode === 409) {
                     this.error(`Error (409): ${err.message}\nSee what is there: faces style:versions ${args.alias}`);
                 }
-                // Reverting a named medium currently fails this way even when the
-                // server itself reports can_revert: true (faces-backend-shared#590).
-                if (err.statusCode === 500) {
-                    this.error(`Error (500): the server failed to revert '${args.alias}'.\n` +
-                        'Reverting a per-medium style is currently broken upstream and nothing was changed. ' +
-                        'Tracked as faces-backend-shared#590.');
-                }
                 this.error(`Error (${err.statusCode}): ${err.message}`);
             }
             throw err;
@@ -71,8 +65,11 @@ export default class StyleRevert extends BaseCommand {
         else {
             this.log(`'${args.alias}' reverted.`);
         }
-        this.log(`To undo this, capture the style again: faces style:make ${args.alias} --all`);
-        this.log(`List versions: faces style:versions ${args.alias}`);
+        // Reverting again returns to where you started — it is a toggle between the
+        // two kept versions, not a walk backwards. Name the version it goes back to
+        // so the user does not have to hold it in their head.
+        const back = from === undefined ? '' : ` to return to version ${from}`;
+        this.log(`Run it again${back}. List versions: faces style:versions ${args.alias}`);
         return data;
     }
 }

package/dist/team-catalog.js

@@ -1,6 +1,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
+import { quoteYaml, unquoteYaml } from './utils.js';
 export const TEAMS_DIR = path.join(os.homedir(), '.faces', 'teams');
 /**
  * Directory name for a team.
@@ -16,12 +17,6 @@ export function slugifyTeamName(name) {
         .replace(/[^a-z0-9]+/g, '-')
         .replace(/^-|-$/g, '');
 }
-function quoteYaml(value) {
-    if (/[:#\[\]{}&*!|>'"%@`\n]/.test(value) || value !== value.trim() || value === '') {
-        return `"${value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
-    }
-    return value;
-}
 function serializeFrontmatter(fm) {
     const lines = ['---'];
     if (fm.id)
@@ -52,13 +47,13 @@ function parseFrontmatter(content) {
         const key = line.slice(0, colonIdx).trim();
         const val = line.slice(colonIdx + 1).trim();
         if (key === 'id') {
-            fm.id = val.replace(/^"(.*)"$/, '$1');
+            fm.id = unquoteYaml(val);
         }
         else if (key === 'name') {
-            fm.name = val.replace(/^"(.*)"$/, '$1');
+            fm.name = unquoteYaml(val);
         }
         else if (key === 'description') {
-            fm.description = val.replace(/^"(.*)"$/, '$1');
+            fm.description = unquoteYaml(val);
         }
         else if (key === 'tags') {
             const inner = val.replace(/^\[/, '').replace(/\]$/, '');

package/dist/utils.d.ts

@@ -87,3 +87,29 @@ export interface ResolvedFace {
 export declare function resolveFace(client: {
     get: (path: string) => Promise<unknown>;
 }, spec: string, include?: string): Promise<ResolvedFace>;
+/**
+ * A description this large is not a description.
+ *
+ * The escaping bug this bound exists to catch grew one field to 128 MiB by
+ * doubling it on every unrelated write. A ceiling turns a silent geometric
+ * corruption into one complaint on the first doubling, and stops a value that
+ * is already corrupt from being carried forward forever.
+ */
+export declare const MAX_FRONTMATTER_VALUE: number;
+/**
+ * Quote a YAML scalar, escaping what would otherwise break the line.
+ *
+ * Paired with {@link unquoteYaml}. The two must stay exact inverses: if one
+ * escapes and the other does not unescape, every read-modify-write doubles the
+ * backslashes in the value, which is invisible until a catalog is measured in
+ * hundreds of megabytes.
+ */
+export declare function quoteYaml(value: string): string;
+/**
+ * Reverse {@link quoteYaml}: strip the surrounding quotes, then unescape.
+ *
+ * The unescape is a single left-to-right pass, not two sequential replaces.
+ * `\\` and `\"` have to be consumed in the order they appear, or a value
+ * containing a literal backslash before a quote comes back wrong.
+ */
+export declare function unquoteYaml(raw: string): string;

package/dist/utils.js

@@ -194,3 +194,40 @@ async function findForeignFace(client, alias, owner, q) {
         owner: ownedBy,
     };
 }
+/**
+ * A description this large is not a description.
+ *
+ * The escaping bug this bound exists to catch grew one field to 128 MiB by
+ * doubling it on every unrelated write. A ceiling turns a silent geometric
+ * corruption into one complaint on the first doubling, and stops a value that
+ * is already corrupt from being carried forward forever.
+ */
+export const MAX_FRONTMATTER_VALUE = 64 * 1024;
+/**
+ * Quote a YAML scalar, escaping what would otherwise break the line.
+ *
+ * Paired with {@link unquoteYaml}. The two must stay exact inverses: if one
+ * escapes and the other does not unescape, every read-modify-write doubles the
+ * backslashes in the value, which is invisible until a catalog is measured in
+ * hundreds of megabytes.
+ */
+export function quoteYaml(value) {
+    if (/[:#[\]{}&*!|>'"%@`\n]/.test(value) || value !== value.trim() || value === '') {
+        return `"${value.replace(/\\/g, '\\\\').replace(/"/g, '\\"')}"`;
+    }
+    return value;
+}
+/**
+ * Reverse {@link quoteYaml}: strip the surrounding quotes, then unescape.
+ *
+ * The unescape is a single left-to-right pass, not two sequential replaces.
+ * `\\` and `\"` have to be consumed in the order they appear, or a value
+ * containing a literal backslash before a quote comes back wrong.
+ */
+export function unquoteYaml(raw) {
+    const trimmed = raw.trim();
+    const m = /^"([\S\s]*)"$/.exec(trimmed);
+    if (!m)
+        return trimmed;
+    return m[1].replace(/\\(["\\])/g, '$1');
+}