tiny.smg.command.node

1const std = @import("std");2const pretty_json = @import("pretty").json;34const smg = @import("../root.zig");5const exports = smg.exports;6const graph_mod = smg.graph;7const model = smg.model;8const options = smg.cli.options;9const output = smg.cli.output;10const resolve = smg.cli.resolve;11const session = smg.command.session;12const storage = smg.storage;13const table = smg.cli.table;14const validation = smg.cli.validation;15const view = smg.view;1617pub fn list(allocator: std.mem.Allocator, _: std.mem.Allocator, args: []const []const u8, limits: smg.Limits, boundary: session.PhaseBoundary) !u8 {18    if (try validation.rejectMissingOptionValues(allocator, args, &.{ "--type", "--format", "--limit" })) return 2;19    if (try validation.rejectUnexpectedOptions(allocator, "list", "[OPTIONS]", args, &.{ "--type", "--format", "--json", "--limit", "--full" })) return 2;20    if (try validation.rejectInvalidChoiceOption(allocator, "list", "[OPTIONS]", args, "--format", &.{ "text", "json" })) return 2;21    if (try validation.rejectInvalidIntegerOption(allocator, "list", "[OPTIONS]", args, "--limit")) return 2;22    const pos = try options.positional(allocator, args);23    if (pos.len != 0) {24        try output.writeClickUsageError(allocator, "list", "[OPTIONS]", try validation.unexpectedArgumentMessage(allocator, pos));25        return 2;26    }27    const type_filter = options.flagValue(args, "--type");28    const limit = options.signedLimitValue(args);29    const root = try storage.requireRoot(allocator);30    const listed = try storage.nodes.listed(31        allocator,32        root,33        type_filter,34        options.storageLimit(limit),35        limits.storage,36    );37    defer storage.nodes.freeListed(allocator, listed);38    boundary.seal();39    defer boundary.beginTeardown();40    const nodes = listed.nodes;41    const total = listed.total;42    const displayed = options.slicedLen(total, limit);43    if (options.hasJson(args)) return try listJson(allocator, nodes, total, displayed, limit);44    var out: std.Io.Writer.Allocating = .init(allocator);45    if (nodes.len == 0) try out.writer.writeAll("No nodes.\n") else try writeListTable(allocator, &out.writer, nodes[0..displayed], total);46    return try output.writeOut(out.written());47}4849pub fn show(allocator: std.mem.Allocator, phases: std.mem.Allocator, args: []const []const u8, limits: smg.Limits, boundary: session.PhaseBoundary) !u8 {50    const command = "show";51    const signature = "[OPTIONS] NAME";52    if (try validation.rejectMissingOptionValues(allocator, args, &.{"--format"})) return 2;53    if (try validation.rejectUnexpectedOptionsPlain(allocator, command, signature, args, &.{ "--format", "--json", "--full" })) return 2;54    if (try validation.rejectInvalidChoiceOption(allocator, command, signature, args, "--format", &.{ "text", "json" })) return 2;55    const pos = try options.positional(allocator, args);56    if (pos.len == 0) {57        try output.writeClickUsageError(allocator, command, signature, "Missing argument 'NAME'.");58        return 2;59    }60    if (pos.len > 1) {61        try output.writeClickUsageError(allocator, command, signature, try validation.unexpectedArgumentMessage(allocator, pos[1..]));62        return 2;63    }64    const loaded = try session.loadRead(allocator, phases, limits, boundary);65    defer boundary.beginTeardown();66    const graph = loaded[1];67    const name = try resolve.graphNode(allocator, graph, pos[0], limits.suggestions);68    const node = graph_mod.getNode(&graph, name) orelse return error.NodeNotFound;69    const incoming = try view.incoming(graph, allocator, name, null);70    const outgoing = try view.outgoing(graph, allocator, name, null);71    if (options.hasJson(args)) return try output.writeOut(try exports.nodeJson(allocator, node, incoming, outgoing));72    var out: std.Io.Writer.Allocating = .init(allocator);73    try render(allocator, &out.writer, node, incoming, outgoing, options.hasFlag(args, "--full"));74    return try output.writeOut(out.written());75}7677pub fn location(allocator: std.mem.Allocator, node: model.Node) ![]const u8 {78    const file = node.file orelse return "";79    if (node.line) |line| {80        if (node.end_line) |end_line| {81            if (end_line != line) return try std.fmt.allocPrint(allocator, "{s}:{d}-{d}", .{ file, line, end_line });82        }83        return try std.fmt.allocPrint(allocator, "{s}:{d}", .{ file, line });84    }85    return file;86}8788pub fn render(allocator: std.mem.Allocator, writer: *std.Io.Writer, node: model.Node, incoming: []const model.Edge, outgoing: []const model.Edge, full: bool) !void {89    try writer.print("{s}  [{s}]\n", .{ node.name, node.type });90    if (node.file) |file| {91        _ = file;92        try writer.print("file:  {s}\n", .{try location(allocator, node)});93    }94    if (node.docstring) |doc| try writer.print("doc:   {s}\n", .{doc});95    try writeMetadata(allocator, writer, node.metadata);96    const limit = if (full) @as(usize, 0) else @as(usize, 20);97    if (incoming.len != 0) {98        try writer.print("\nIncoming ({d})\n", .{incoming.len});99        try writeEdgeLines(writer, incoming, limit);100    }101    if (outgoing.len != 0) {102        try writer.print("\nOutgoing ({d})\n", .{outgoing.len});103        try writeEdgeLines(writer, outgoing, limit);104    }105}106107pub fn writeMetadata(allocator: std.mem.Allocator, writer: *std.Io.Writer, pairs: []const model.Pair) !void {108    const sorted = try allocator.dupe(model.Pair, pairs);109    std.mem.sort(model.Pair, sorted, {}, metadataLess);110    for (sorted) |pair| try writer.print("{s}:  {s}\n", .{ pair.key, pair.value });111}112113fn metadataLess(_: void, a: model.Pair, b: model.Pair) bool {114    return std.mem.lessThan(u8, a.key, b.key);115}116117pub fn writeEdgeLines(writer: *std.Io.Writer, edges: []const model.Edge, limit: usize) !void {118    for (edges, 0..) |edge, index| {119        if (limit != 0 and index >= limit) {120            try writer.print("  ... and {d} more\n", .{edges.len - limit});121            break;122        }123        try writer.print("  {s} --{s}--> {s}\n", .{ edge.source, edge.rel, edge.target });124    }125}126127pub fn listJson(allocator: std.mem.Allocator, nodes: []const model.Node, total: usize, displayed: usize, limit: i64) !u8 {128    return try output.writeOut(try renderListJson(allocator, nodes, total, displayed, limit));129}130131pub fn renderListJson(allocator: std.mem.Allocator, nodes: []const model.Node, total: usize, displayed: usize, limit: i64) ![]const u8 {132    var out: std.Io.Writer.Allocating = .init(allocator);133    errdefer out.deinit();134    var scratch_state = std.heap.ArenaAllocator.init(allocator);135    defer scratch_state.deinit();136    const scratch = scratch_state.allocator();137    var writer = pretty_json.Writer.init(&out.writer, .minified);138    try writer.beginObject();139    try writer.objectField("rows");140    try writer.beginArray();141    for (nodes[0..displayed]) |item| {142        try writer.beginObject();143        try writer.objectField("type");144        try writer.write(item.type);145        try writer.objectField("name");146        try writer.write(item.name);147        try writer.objectField("file");148        try writer.write(try location(scratch, item));149        try writer.endObject();150    }151    try writer.endArray();152    try writer.objectField("total");153    try writer.write(total);154    try writer.objectField("displayed");155    try writer.write(displayed);156    try writer.objectField("truncated");157    try writer.write(displayed < total);158    try writer.objectField("limit");159    try writer.write(limit);160    try writer.endObject();161    try out.writer.writeByte('\n');162    return try out.toOwnedSlice();163}164165pub fn writeListTable(allocator: std.mem.Allocator, writer: *std.Io.Writer, nodes: []const model.Node, total: usize) !void {166    const columns = [_]table.Column{167        .{ .header = "type", .max_width = 12 },168        .{ .header = "name", .max_width = 40 },169        .{ .header = "file", .max_width = 40 },170    };171    var scratch_state = std.heap.ArenaAllocator.init(allocator);172    defer scratch_state.deinit();173    const scratch = scratch_state.allocator();174    var rows: std.ArrayList([]const []const u8) = .empty;175    for (nodes) |item| {176        try table.appendRow(scratch, &rows, &.{177            item.type,178            item.name,179            try location(scratch, item),180        });181    }182    try table.write(allocator, writer, &columns, rows.items, total);183}184185test "location includes end line when distinct" {186    const allocator = std.testing.allocator;187    const value = try location(allocator, .{ .name = "app.range", .type = model.NodeType.function, .file = "src/app.py", .line = 4, .end_line = 8 });188    defer allocator.free(value);189    try std.testing.expectEqualStrings("src/app.py:4-8", value);190}191192test "metadata renders sorted for show text" {193    var arena = std.heap.ArenaAllocator.init(std.testing.allocator);194    defer arena.deinit();195    const allocator = arena.allocator();196    const pairs = [_]model.Pair{197        .{ .key = "source", .value = "manual" },198        .{ .key = "metrics", .value = "{}" },199    };200    var out: std.Io.Writer.Allocating = .init(allocator);201    try writeMetadata(allocator, &out.writer, &pairs);202    try std.testing.expectEqualStrings(203        \\metrics:  {}204        \\source:  manual205        \\206    , out.written());207}208209test "list table renders sorted nodes with source locations" {210    var arena = std.heap.ArenaAllocator.init(std.testing.allocator);211    defer arena.deinit();212    const allocator = arena.allocator();213    const nodes = [_]model.Node{214        .{ .name = "app", .type = model.NodeType.module, .file = "src/app.py" },215        .{ .name = "app.helper", .type = model.NodeType.function, .file = "src/app.py", .line = 5 },216        .{ .name = "app.main", .type = model.NodeType.function, .file = "src/app.py", .line = 1 },217    };218    var out: std.Io.Writer.Allocating = .init(allocator);219    try writeListTable(allocator, &out.writer, &nodes, nodes.len);220    try std.testing.expectEqualStrings(221        \\type      name        file222        \\--------  ----------  ------------223        \\module    app         src/app.py224        \\function  app.helper  src/app.py:5225        \\function  app.main    src/app.py:1226        \\227    , out.written());228}229230test "list json renders location and truncation fields" {231    const allocator = std.testing.allocator;232    const nodes = [_]model.Node{233        .{ .name = "app", .type = model.NodeType.module, .file = "src/app.py" },234        .{ .name = "app.helper", .type = model.NodeType.function, .file = "src/app.py", .line = 5 },235    };236    const rendered = try renderListJson(allocator, &nodes, 3, 2, 2);237    defer allocator.free(rendered);238    try std.testing.expectEqualStrings(239        "{\"rows\":[{\"type\":\"module\",\"name\":\"app\",\"file\":\"src/app.py\"},{\"type\":\"function\",\"name\":\"app.helper\",\"file\":\"src/app.py:5\"}],\"total\":3,\"displayed\":2,\"truncated\":true,\"limit\":2}\n",240        rendered,241    );242}

1pub const node = @import("node.zig");