@dropsh/plugin-table 0.5.2

package/LICENSE

@@ -0,0 +1,51 @@
+drupal-cli is dual-licensed. You may use this software under the terms of
+either the MIT License or the GNU General Public License version 2 or any
+later version, at your option.
+
+SPDX-License-Identifier: (MIT OR GPL-2.0-or-later)
+
+================================================================================
+MIT License
+================================================================================
+
+Copyright (c) 2026 Christian Wiedemann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+================================================================================
+GNU General Public License, version 2 or later
+================================================================================
+
+The full text of the GNU GPL v2 is available at:
+  https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
+
+The full text of any later GPL version is available at:
+  https://www.gnu.org/licenses/
+
+Copyright (C) 2026 Christian Wiedemann
+
+This program is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free Software
+Foundation; either version 2 of the License, or (at your option) any later
+version.
+
+This program is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+details.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@dropsh/plugin-table",
+  "version": "0.5.2",
+  "type": "module",
+  "main": "./dist/plugins/table/src/index.js",
+  "exports": {
+    ".": "./dist/plugins/table/src/index.js",
+    "./render": "./dist/plugins/table/src/render-table.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "dropsh": "*"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0",
+    "vitest": "^2.1.0",
+    "dropsh": "0.5.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run --passWithNoTests",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/src/columns.ts

@@ -0,0 +1,41 @@
+import type { JsonApiResource } from "dropsh/plugin";
+
+const PREFERRED = ["title", "name", "label", "status"];
+const MAX_CELL = 40;
+const MAX_COLS = 5;
+
+function isScalar(v: unknown): boolean {
+  return typeof v === "string" || typeof v === "number" || typeof v === "boolean";
+}
+
+export function pickColumns(res: JsonApiResource): string[] {
+  const attrs = res.attributes ?? {};
+  const scalars = Object.entries(attrs)
+    .filter(([, v]) => isScalar(v))
+    .map(([k]) => k);
+  const preferred = PREFERRED.filter((k) => scalars.includes(k));
+  const rest = scalars.filter((k) => !preferred.includes(k));
+  return ["id", ...preferred, ...rest].slice(0, MAX_COLS);
+}
+
+export function cell(v: unknown): string {
+  const s = v === undefined || v === null ? "" : String(v);
+  return s.length > MAX_CELL ? `${s.slice(0, MAX_CELL - 1)}…` : s;
+}
+
+export function formatTable(headers: string[], rows: string[][]): string {
+  const widths = headers.map((h, i) =>
+    Math.max(h.length, ...rows.map((r) => (r[i] ?? "").length), 0),
+  );
+  const bar = (l: string, m: string, r: string) =>
+    `${l}${widths.map((w) => "─".repeat(w + 2)).join(m)}${r}`;
+  const line = (cells: string[]) =>
+    `│ ${cells.map((c, i) => (c ?? "").padEnd(widths[i] ?? 0)).join(" │ ")} │`;
+  return [
+    bar("┌", "┬", "┐"),
+    line(headers),
+    bar("├", "┼", "┤"),
+    ...rows.map(line),
+    bar("└", "┴", "┘"),
+  ].join("\n");
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+import type { DropSHPlugin } from "dropsh/plugin";
+import { renderTable } from "./render-table.js";
+
+export { renderTable };
+
+export function tablePlugin(): DropSHPlugin {
+  return {
+    id: "table",
+    requiredModules: [],
+    async extendSchema(_entityType, _bundle, schema) {
+      return schema;
+    },
+    renderers: [{ id: "table", render: renderTable }],
+  };
+}

package/src/render-table.ts

@@ -0,0 +1,30 @@
+import type { JsonApiDocument, RenderContext } from "dropsh/plugin";
+import { cell, formatTable, pickColumns } from "./columns.js";
+
+export { formatTable, pickColumns };
+
+function isScalar(v: unknown): boolean {
+  return typeof v === "string" || typeof v === "number" || typeof v === "boolean";
+}
+
+export function renderTable(doc: JsonApiDocument, _ctx: RenderContext): string {
+  const data = doc.data;
+  if (Array.isArray(data)) {
+    if (data.length === 0) return "(0 rows)";
+    const first = data[0];
+    if (!first) return "(0 rows)";
+    const cols = pickColumns(first);
+    const rows = data.map((res) =>
+      cols.map((c) => cell(c === "id" ? res.id : (res.attributes ?? {})[c])),
+    );
+    return formatTable(cols, rows);
+  }
+  const rows: string[][] = [
+    ["type", data.type],
+    ["id", data.id],
+  ];
+  for (const [k, v] of Object.entries(data.attributes ?? {})) {
+    if (isScalar(v)) rows.push([k, cell(v)]);
+  }
+  return formatTable(["field", "value"], rows);
+}

package/tests/unit/render-table.test.ts

@@ -0,0 +1,53 @@
+import { describe, expect, it } from "vitest";
+import { pickColumns, renderTable } from "../../src/render-table.js";
+
+const ctx = { command: "search" as const };
+
+describe("pickColumns", () => {
+  it("puts id first and prefers title/status", () => {
+    const cols = pickColumns({
+      type: "node--article",
+      id: "u1",
+      attributes: { body: "x", status: true, title: "T" },
+    });
+    expect(cols[0]).toBe("id");
+    expect(cols).toContain("title");
+    expect(cols).toContain("status");
+  });
+});
+
+describe("renderTable", () => {
+  it("renders a collection as an aligned box table", () => {
+    const out = renderTable(
+      {
+        data: [
+          { type: "node--article", id: "u1", attributes: { title: "Alpha", status: true } },
+          { type: "node--article", id: "u2", attributes: { title: "Beta", status: false } },
+        ],
+      },
+      ctx,
+    );
+    const lines = out.split("\n");
+    // biome-ignore lint/style/noNonNullAssertion: split() on a non-empty string always yields at least one element
+    expect(lines[0]!.startsWith("┌")).toBe(true);
+    expect(out).toContain("u1");
+    expect(out).toContain("Alpha");
+    // every rendered line is the same visual width
+    expect(new Set(lines.map((l) => [...l].length)).size).toBe(1);
+  });
+
+  it("renders an empty collection as (0 rows)", () => {
+    expect(renderTable({ data: [] }, ctx)).toBe("(0 rows)");
+  });
+
+  it("renders a single resource as a key/value table", () => {
+    const out = renderTable(
+      { data: { type: "node--article", id: "u1", attributes: { title: "Solo" } } },
+      { command: "read" },
+    );
+    expect(out).toContain("field");
+    expect(out).toContain("value");
+    expect(out).toContain("title");
+    expect(out).toContain("Solo");
+  });
+});

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "noEmit": false
+  },
+  "include": ["src", "tests"]
+}

package/vitest.config.ts

@@ -0,0 +1,14 @@
+import { resolve } from "node:path";
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  resolve: {
+    alias: {
+      "dropsh/plugin": resolve(__dirname, "../../src/plugin-api.ts"),
+    },
+  },
+  test: {
+    include: ["tests/unit/**/*.test.ts"],
+    environment: "node",
+  },
+});