@daweifu/capability-menu 0.1.1 → 0.1.3

package/lib/patch-file.js

@@ -0,0 +1,192 @@
+/**
+ * Comment-preserving, loop-safe editing of a dsh patch file.
+ *
+ * dsh owns and composes these files (`~/.dsh/cordis.patch.yml` and per-profile
+ * `cordis.patch.yml`), and in a `patchReload: live` profile it *watches* them:
+ * any write triggers a transactional re-apply of the patch, which re-applies
+ * this very plugin. Two consequences drive everything below:
+ *
+ * - **A no-op must never write.** Writing on every startup/apply would make the
+ *   plugin reload itself forever. So each mutation reports whether it actually
+ *   changed the document, and nothing is written when it did not.
+ * - **A write must never damage the file.** The file is a hand-maintained asset
+ *   (comments, `!!js` expressions, credentials). Edits go through `yaml`'s
+ *   document API, which keeps comments, and every write is backed up, verified
+ *   by re-parsing, and rolled back on failure.
+ *
+ * Note the round-trip is *not* byte-identical — `yaml` normalizes trailing
+ * comment spacing and quoting style. That is why "did this change anything?" is
+ * decided by the mutation, never by comparing before/after text.
+ */
+import { copyFile, readFile, rename, unlink, writeFile } from 'node:fs/promises';
+import { randomUUID } from 'node:crypto';
+import { homedir } from 'node:os';
+import { join } from 'node:path';
+import YAML from 'yaml';
+/** Default patch file: the home-level layer shared by every profile. */
+export function defaultPatchFile() {
+    const home = process.env['DSH_HOME'];
+    if (home !== undefined && home.length > 0)
+        return join(home, 'cordis.patch.yml');
+    return join(homedir(), '.dsh', 'cordis.patch.yml');
+}
+/**
+ * Every entry row in the document: both bare top-level rows and rows nested in
+ * an `- insert:` block (the form dsh's own patches and this bundle use).
+ */
+function* entryNodes(doc) {
+    const root = doc.contents;
+    if (!YAML.isSeq(root))
+        return;
+    for (const item of root.items) {
+        if (!YAML.isMap(item))
+            continue;
+        const insert = item.get('insert');
+        if (insert !== undefined && insert !== null) {
+            if (!YAML.isSeq(insert))
+                continue;
+            for (const row of insert.items) {
+                if (YAML.isMap(row))
+                    yield { node: row, parent: insert };
+            }
+            continue;
+        }
+        if (item.get('id') !== undefined)
+            yield { node: item, parent: root };
+    }
+}
+/** Find the entry row with `id`, if the file declares one. */
+export function findEntry(doc, id) {
+    for (const { node } of entryNodes(doc)) {
+        if (node.get('id') === id)
+            return node;
+    }
+    return undefined;
+}
+/** Read every declared entry as plain data (never mutates the file). */
+export async function readEntries(file) {
+    const source = await readFile(file, 'utf8');
+    const doc = YAML.parseDocument(source);
+    const entries = [];
+    for (const { node } of entryNodes(doc)) {
+        const value = node.toJSON();
+        if (typeof value.id !== 'string' || typeof value.name !== 'string')
+            continue;
+        entries.push(value);
+    }
+    return entries;
+}
+/** The last `- insert:` block in the document, if any. */
+function lastInsertSeq(doc) {
+    const root = doc.contents;
+    if (!YAML.isSeq(root))
+        return undefined;
+    let found;
+    for (const item of root.items) {
+        if (!YAML.isMap(item))
+            continue;
+        const insert = item.get('insert');
+        if (YAML.isSeq(insert))
+            found = insert;
+    }
+    return found;
+}
+/**
+ * Append a row to the document. Reuses the last `- insert:` block so new rows
+ * land next to the existing ones; creates one when the file has none.
+ */
+export function addEntry(doc, entry) {
+    const root = doc.contents;
+    if (!YAML.isSeq(root))
+        throw new Error('patch file root is not a sequence');
+    const target = lastInsertSeq(doc) ?? (() => {
+        const block = doc.createNode({ insert: [] });
+        // `root` is narrowed to a parsed sequence; the freshly built map is not
+        // narrowed with it even though it is a real document node.
+        root.add(block);
+        return block.get('insert');
+    })();
+    target.add(doc.createNode({ ...entry }));
+}
+/**
+ * Append a bare, id-targeted override row (`- id: … / name: … / config: …`) at
+ * the top level — a patch that *finds* a row instead of adding one.
+ *
+ * Deliberately not {@link addEntry}: the row being configured is usually
+ * contributed by another layer. This plugin's own bundle patch inserts
+ * `capability-menu-policy`, and a profile's home layer is applied *after* that
+ * layer, so inserting a second row with the same id here leaves the composed
+ * tree with two rows sharing an id — which dsh refuses outright with
+ * `duplicate loader entry id`, taking the whole profile down.
+ */
+export function addEntryOverride(doc, entry) {
+    const root = doc.contents;
+    if (!YAML.isSeq(root))
+        throw new Error('patch file root is not a sequence');
+    // `root` is narrowed to a parsed sequence; the freshly built map is not
+    // narrowed with it even though it is a real document node.
+    root.add(doc.createNode({ ...entry }));
+}
+/** Remove the row with `id`. Returns false when the file has no such row. */
+export function removeEntry(doc, id) {
+    for (const { node, parent } of entryNodes(doc)) {
+        if (node.get('id') !== id)
+            continue;
+        parent.delete(parent.items.indexOf(node));
+        return true;
+    }
+    return false;
+}
+/** Set or clear `disabled:` on the row with `id`. */
+export function setEntryDisabled(doc, id, disabled) {
+    const node = findEntry(doc, id);
+    if (node === undefined)
+        return false;
+    if (disabled)
+        node.set('disabled', true);
+    else
+        node.delete('disabled');
+    return true;
+}
+/** Replace the row's `config:` (patch semantics replace the whole value). */
+export function setEntryConfig(doc, id, config) {
+    const node = findEntry(doc, id);
+    if (node === undefined)
+        return false;
+    node.set('config', doc.createNode(config));
+    return true;
+}
+/**
+ * Load the patch file, apply `mutate`, and persist only when it reports a
+ * change. Returns whether a write happened (i.e. whether dsh will hot-reload).
+ *
+ * `mutate` must be pure apart from its edits to `doc`: it may be the only
+ * chance to change the file, and a thrown error leaves the file untouched.
+ */
+export async function mutatePatch(file, mutate) {
+    const original = await readFile(file, 'utf8');
+    const doc = YAML.parseDocument(original);
+    if (!mutate(doc))
+        return false;
+    const next = doc.toString();
+    const backup = `${file}.bak`;
+    const tmp = `${file}.tmp-${randomUUID()}`;
+    await copyFile(file, backup);
+    try {
+        await writeFile(tmp, next, 'utf8');
+        // Verify before it becomes the live file: a document that no longer parses
+        // would take the whole profile down on the next reload.
+        const check = YAML.parseDocument(await readFile(tmp, 'utf8'));
+        if (check.errors.length > 0) {
+            throw new Error(`rewritten patch file does not parse: ${check.errors[0]?.message ?? 'unknown error'}`);
+        }
+        await rename(tmp, file);
+        return true;
+    }
+    catch (error) {
+        await unlink(tmp).catch(() => { });
+        await copyFile(backup, file).catch(() => { });
+        throw error;
+    }
+}
+//# sourceMappingURL=patch-file.js.map

package/lib/patch-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch-file.js","sourceRoot":"","sources":["../src/patch-file.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACjC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAA;AAChC,OAAO,IAAI,MAAM,MAAM,CAAA;AAUvB,wEAAwE;AACxE,MAAM,UAAU,gBAAgB;IAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;IACpC,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAA;IAChF,OAAO,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,kBAAkB,CAAC,CAAA;AACpD,CAAC;AAED;;;GAGG;AACH,QAAQ,CAAC,CAAC,UAAU,CAAC,GAAyB;IAC5C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAA;IACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAM;IAC7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,SAAQ;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACjC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,SAAQ;YACjC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;oBAAE,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;YAC1D,CAAC;YACD,SAAQ;QACV,CAAC;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,SAAS;YAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAA;IACtE,CAAC;AACH,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,SAAS,CAAC,GAAyB,EAAE,EAAU;IAC7D,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACvC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE;YAAE,OAAO,IAAI,CAAA;IACxC,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,wEAAwE;AACxE,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,IAAY;IAC5C,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAA;IACtC,MAAM,OAAO,GAAiB,EAAE,CAAA;IAChC,KAAK,MAAM,EAAE,IAAI,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAyB,CAAA;QAClD,IAAI,OAAO,KAAK,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;YAAE,SAAQ;QAC5E,OAAO,CAAC,IAAI,CAAC,KAAmB,CAAC,CAAA;IACnC,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,0DAA0D;AAC1D,SAAS,aAAa,CAAC,GAAyB;IAC9C,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAA;IACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,OAAO,SAAS,CAAA;IACvC,IAAI,KAA+B,CAAA;IACnC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,SAAQ;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACjC,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;YAAE,KAAK,GAAG,MAAM,CAAA;IACxC,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,GAAyB,EAAE,KAAiB;IACnE,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAA;IACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IAC3E,MAAM,MAAM,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,GAAiB,EAAE;QACvD,MAAM,KAAK,GAAG,GAAG,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAiB,CAAA;QAC5D,wEAAwE;QACxE,2DAA2D;QAC3D,IAAI,CAAC,GAAG,CAAC,KAAmC,CAAC,CAAA;QAC7C,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAiB,CAAA;IAC5C,CAAC,CAAC,EAAE,CAAA;IACJ,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC,CAAA;AAC1C,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,gBAAgB,CAAC,GAAyB,EAAE,KAAiB;IAC3E,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAA;IACzB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;IAC3E,wEAAwE;IACxE,2DAA2D;IAC3D,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,GAAG,KAAK,EAAE,CAA+B,CAAC,CAAA;AACtE,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,WAAW,CAAC,GAAyB,EAAE,EAAU;IAC/D,KAAK,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE;YAAE,SAAQ;QACnC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;QACzC,OAAO,IAAI,CAAA;IACb,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,gBAAgB,CAAC,GAAyB,EAAE,EAAU,EAAE,QAAiB;IACvF,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAC/B,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAA;IACpC,IAAI,QAAQ;QAAE,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;;QACnC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IAC5B,OAAO,IAAI,CAAA;AACb,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,cAAc,CAAC,GAAyB,EAAE,EAAU,EAAE,MAA+B;IACnG,MAAM,IAAI,GAAG,SAAS,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;IAC/B,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,KAAK,CAAA;IACpC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAA;IAC1C,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,IAAY,EACZ,MAA8C;IAE9C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;IACxC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAA;IAE9B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAA;IAC3B,MAAM,MAAM,GAAG,GAAG,IAAI,MAAM,CAAA;IAC5B,MAAM,GAAG,GAAG,GAAG,IAAI,QAAQ,UAAU,EAAE,EAAE,CAAA;IACzC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC5B,IAAI,CAAC;QACH,MAAM,SAAS,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAClC,2EAA2E;QAC3E,wDAAwD;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA;QAC7D,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,wCAAwC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC,CAAA;QACxG,CAAC;QACD,MAAM,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QACjC,MAAM,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAA;QAC5C,MAAM,KAAK,CAAA;IACb,CAAC;AACH,CAAC"}