@vltpkg/graph 1.3.8 → 1.5.0

package/dist/update.js

@@ -12,6 +12,8 @@ import { RollbackRemove } from '@vltpkg/rollback-remove';
 import { Monorepo } from '@vltpkg/workspaces';
 import { existsSync, rmSync } from 'node:fs';
 import { resolve } from 'node:path';
+import { assertQuery } from "./filter-nodes-by-query.js";
+import { assertSkillsDirs } from "./skills/dirs.js";
 /**
  * Graph to update from. `-w` filtered: the lockfile (else installed)
  * graph minus the selected workspaces' deps, so only those re-resolve
@@ -45,6 +47,16 @@ const startingGraph = (options, monorepo) => {
     return graph;
 };
 export const update = async (options) => {
+    // unset or `:not(*)`: no skills work at all, the skills code never
+    // loads
+    const allowSkills = options.allowSkills === ':not(*)' ?
+        undefined
+        : options.allowSkills;
+    // fail before updating, not after
+    if (allowSkills) {
+        await assertQuery(allowSkills, 'allow-skills', ['skill']);
+        assertSkillsDirs(options.projectRoot, options.skillsDirs);
+    }
     let mainManifest = undefined;
     try {
         mainManifest = options.packageJson.read(options.projectRoot);
@@ -66,6 +78,7 @@ export const update = async (options) => {
         packageJson: options.packageJson,
         scurry: options.scurry,
     });
+    let result;
     try {
         const done = graphStep('build');
         const graph = await buildIdealFromStartingGraph({
@@ -94,7 +107,7 @@ export const update = async (options) => {
             remover,
             update: true,
         });
-        return { buildQueue, graph, diff };
+        result = { buildQueue, graph, diff };
         /* c8 ignore start */
     }
     catch (err) {
@@ -110,4 +123,14 @@ export const update = async (options) => {
         throw err;
     }
     /* c8 ignore stop */
+    // after the try: a link failure must not roll back the update
+    if (!allowSkills)
+        return result;
+    const { linkSkills } = await import("./skills/index.js");
+    result.skills = await linkSkills({
+        ...options,
+        graph: result.graph,
+        target: allowSkills,
+    });
+    return result;
 };

package/dist/visualization/mermaid-output.d.ts

@@ -1,9 +1,17 @@
+import type { DepID } from '@vltpkg/dep-id';
 import type { EdgeLike, NodeLike } from '@vltpkg/types';
+/** A leaf drawn under a graph node: node label, optional edge label. */
+export type MermaidChild = {
+    label: string;
+    edge?: string;
+};
 export type MermaidOutputGraph = {
     edges: EdgeLike[];
     importers: Set<NodeLike>;
     nodes: NodeLike[];
     highlightSelection?: boolean;
+    /** leaves to draw under included nodes (class `b`), eg: skills */
+    children?: Map<DepID, MermaidChild[]>;
 };
 /**
  * Generates a short identifier for a given index following the pattern:

package/dist/visualization/mermaid-output.js

@@ -1,6 +1,7 @@
 import { Edge } from "../edge.js";
 import { Node } from "../node.js";
 let missingCount = 0;
+const escapeLabel = (s) => s.replaceAll('"', '#quot;').replaceAll('@', '#64;');
 const isSelected = (options, edge, node) => (!node || options.nodes.includes(node)) &&
     /* c8 ignore next */ (!edge || options.edges.includes(edge));
 /**
@@ -72,7 +73,7 @@ const nodeRef = (node, labeledNodes, depIdMapping, options) => {
     labeledNodes.add(node.id);
     return `${shortId}("${String(node).replaceAll('@', '#64;')}")${selectedClass}`;
 };
-function parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, node, isImporter = false) {
+function parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, leaves, node, isImporter = false) {
     if (seenNodes.has(node.id) || !includedItems.get(node)) {
         return '';
     }
@@ -87,8 +88,10 @@ function parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options
         ...node.edgesOut.values(),
         ...(node.workspaces?.values() ?? []),
     ];
-    const edges = allEdges
-        .map(e => parseEdge(seenNodes, labeledNodes, includedItems, depIdMapping, options, e))
+    const edges = [
+        leaves.get(node.id),
+        ...allEdges.map(e => parseEdge(seenNodes, labeledNodes, includedItems, depIdMapping, options, leaves, e)),
+    ]
         .filter(Boolean)
         .join('\n');
     // Only render node standalone for importers, others are rendered as part of edges
@@ -98,7 +101,7 @@ function parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options
     }
     return edges;
 }
-function parseEdge(seenNodes, labeledNodes, includedItems, depIdMapping, options, edge) {
+function parseEdge(seenNodes, labeledNodes, includedItems, depIdMapping, options, leaves, edge) {
     if (!includedItems.get(edge)) {
         return '';
     }
@@ -112,14 +115,14 @@ function parseEdge(seenNodes, labeledNodes, includedItems, depIdMapping, options
     // Label the target node first so that if it's referenced again later in the graph,
     // it will use the short identifier instead of repeating the full label.
     const toRef = nodeRef(edge.to, labeledNodes, depIdMapping, options);
-    const childEdges = parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, edge.to);
+    const childEdges = parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, leaves, edge.to);
     return edgeResult + toRef + (childEdges ? '\n' + childEdges : '');
 }
 /**
  * Returns a mermaid string representation of the graph.
  */
 export function mermaidOutput(options) {
-    const { edges, importers, nodes, highlightSelection } = options;
+    const { edges, importers, nodes, highlightSelection, children } = options;
     const seen = new Set();
     const includedItems = new Map();
     const traverse = new Set([...importers].map(i => ({ self: i, parent: undefined })));
@@ -157,14 +160,28 @@ export function mermaidOutput(options) {
     }
     // Create DepID to short identifier mapping
     const depIdMapping = createDepIdMapping(importers);
+    // leaf lines per node, ids after the graph's
+    const leaves = new Map();
+    let leafIndex = depIdMapping.size;
+    for (const [id, items] of children ?? []) {
+        const from = depIdMapping.get(id);
+        if (!from || !items.length)
+            continue;
+        leaves.set(id, items
+            .map(({ label, edge }) => `${from} -->${edge === undefined ? '' : `|"${escapeLabel(edge)}"|`} ${generateShortId(leafIndex++)}("${escapeLabel(label)}"):::b`)
+            .join('\n'));
+    }
     // Track nodes that have had their label printed (shared across all importers)
     const labeledNodes = new Set();
     // Track nodes that have been processed (shared across all importers to avoid duplicates)
     const seenNodes = new Set();
     const graphOutput = [...importers]
-        .map(i => parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, i, true))
+        .map(i => parseNode(seenNodes, labeledNodes, includedItems, depIdMapping, options, leaves, i, true))
         .filter(Boolean)
         .join('\n');
-    const styleDefinition = highlightSelection ? '\nclassDef a fill:gold,color:#242424' : '';
+    const styleDefinition = (highlightSelection ?
+        '\nclassDef a fill:gold,color:#242424'
+        : '') +
+        (leaves.size ? '\nclassDef b fill:turquoise,color:#242424' : '');
     return 'flowchart TD\n' + graphOutput + styleDefinition;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vltpkg/graph",
   "description": "A library that helps understanding & expressing what happens on an install",
-  "version": "1.3.8",
+  "version": "1.5.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vltpkg/vltpkg.git",
@@ -13,26 +13,26 @@
     "url": "http://vlt.sh"
   },
   "dependencies": {
-    "@vltpkg/cmd-shim": "1.3.8",
-    "@vltpkg/dep-id": "1.3.8",
-    "@vltpkg/dss-breadcrumb": "1.3.8",
-    "@vltpkg/error-cause": "1.3.8",
-    "@vltpkg/fast-split": "1.3.8",
-    "@vltpkg/graph-run": "1.3.8",
-    "@vltpkg/init": "1.3.8",
-    "@vltpkg/output": "1.3.8",
-    "@vltpkg/package-info": "1.3.8",
-    "@vltpkg/package-json": "1.3.8",
-    "@vltpkg/pick-manifest": "1.3.8",
-    "@vltpkg/query": "1.3.8",
-    "@vltpkg/rollback-remove": "1.3.8",
-    "@vltpkg/run": "1.3.8",
-    "@vltpkg/satisfies": "1.3.8",
-    "@vltpkg/security-archive": "1.3.8",
-    "@vltpkg/spec": "1.3.8",
-    "@vltpkg/types": "1.3.8",
-    "@vltpkg/vlt-json": "1.3.8",
-    "@vltpkg/workspaces": "1.3.8",
+    "@vltpkg/cmd-shim": "1.5.0",
+    "@vltpkg/dep-id": "1.5.0",
+    "@vltpkg/dss-breadcrumb": "1.5.0",
+    "@vltpkg/error-cause": "1.5.0",
+    "@vltpkg/fast-split": "1.5.0",
+    "@vltpkg/graph-run": "1.5.0",
+    "@vltpkg/init": "1.5.0",
+    "@vltpkg/output": "1.5.0",
+    "@vltpkg/package-info": "1.5.0",
+    "@vltpkg/package-json": "1.5.0",
+    "@vltpkg/pick-manifest": "1.5.0",
+    "@vltpkg/query": "1.5.0",
+    "@vltpkg/rollback-remove": "1.5.0",
+    "@vltpkg/run": "1.5.0",
+    "@vltpkg/satisfies": "1.5.0",
+    "@vltpkg/security-archive": "1.5.0",
+    "@vltpkg/spec": "1.5.0",
+    "@vltpkg/types": "1.5.0",
+    "@vltpkg/vlt-json": "1.5.0",
+    "@vltpkg/workspaces": "1.5.0",
     "path-scurry": "^2.0.1",
     "promise-call-limit": "^3.0.2"
   },