Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .jules/bolt.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 2026-06-09 - Optimize File System Traversal
**Learning:** Combining `fs.readdirSync` with `fs.statSync` for every file is a major performance bottleneck for local-first CLI tools that traverse many files.
**Action:** Always prefer `fs.readdirSync(..., { withFileTypes: true })` to avoid redundant syscalls, which significantly speeds up directory traversal.


## 2025-02-12 - Concurrent File Reading for CLI Performance
**Learning:** Using synchronous `readFileSync` inside loops during filesystem traversal (like in `listUseCases`) creates a significant performance bottleneck for the CLI as the number of spec files grows.
**Action:** When a CLI command needs to read multiple files from disk to aggregate data, use `fs.promises.readFile` with `Promise.all()` instead of synchronous loops to read files concurrently, and ensure the command wrapper supports asynchronous execution.
9 changes: 5 additions & 4 deletions src/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -307,17 +307,18 @@ function suggestDoctorActions(findings: { rule: string; message: string }[]) {
return actions;
}

function runCommand<T>(
fn: () => T,
payload: (data: T) => {
async function runCommand<T>(
fn: () => T | Promise<T>,
payload: (data: Awaited<T>) => {
data: unknown;
affectedFiles?: { path: string }[];
warnings?: { message: string }[];
suggestedNextActions: { command: string; reason?: string }[];
},
) {
try {
outputSuccess(payload(fn()));
const result = (await fn()) as Awaited<T>;
outputSuccess(payload(result));
} catch (error) {
const info = errorInfo(error);
outputError({ code: info.code, message: info.message, details: info.details, actions: info.actions });
Expand Down
18 changes: 14 additions & 4 deletions src/usecase-commands.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { existsSync, readFileSync, writeFileSync } from "node:fs";
import { existsSync, readFileSync, writeFileSync, promises as fsPromises } from "node:fs";
import { join } from "node:path";
import {
orderActorFrontmatter,
Expand Down Expand Up @@ -84,11 +84,21 @@ export function createUseCase(args: {
return { key, path: relativePath(path, root), format: "BRIEF" as const, affectedFiles };
}

export function listUseCases(args: { cwd?: string; status?: string; actor?: string; level?: string; q?: string }) {
export async function listUseCases(args: { cwd?: string; status?: string; actor?: string; level?: string; q?: string }) {
const config = readConfig(args.cwd ?? process.cwd());
if (!config) throw new Error("NOT_INITIALIZED");
return walkFiles(join(config.root, "specs/usecases"), (path) => path.endsWith(".md"))
.map((path) => ({ path, parsed: parseUseCaseMarkdown(readFileSync(path, "utf8")) }))

const files = walkFiles(join(config.root, "specs/usecases"), (path) => path.endsWith(".md"));

// ⚡ Bolt: Read files concurrently using Promise.all
const readPromises = files.map(async (path) => {
const text = await fsPromises.readFile(path, "utf8");
return { path, parsed: parseUseCaseMarkdown(text) };
});

const parsedFiles = await Promise.all(readPromises);

return parsedFiles
.filter(({ parsed }) => !args.status || parsed.frontmatter.status === args.status.toUpperCase())
.filter(({ parsed }) => !args.actor || parsed.frontmatter.primary_actor === slugify(args.actor!))
.filter(({ parsed }) => !args.level || parsed.frontmatter.level === parseLevel(args.level!))
Expand Down
4 changes: 2 additions & 2 deletions tests/authoring.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ import { normalizeUseCaseMarkdown } from "../src/format/normalize.js";
import { runDoctor } from "../src/validate/doctor.js";

describe("use-case authoring loop", () => {
it("runs init -> usecase create -> round-trip -> doctor with no errors", () => {
it("runs init -> usecase create -> round-trip -> doctor with no errors", async () => {
const root = join(tmpdir(), `vspec-authoring-${crypto.randomUUID()}`);
mkdirSync(root, { recursive: true });
initProject({ root, key: "VSPEC" });
const created = createUseCase({ cwd: root, title: "Author a use case", primaryActor: "developer" });
const file = readFileSync(join(root, created.path), "utf8");
expect(serializeUseCase(parseUseCaseMarkdown(file))).toBe(normalizeUseCaseMarkdown(file));
expect(runDoctor({ root, target: created.key }).findings.filter((finding) => finding.level === "error")).toEqual([]);
expect(listUseCases({ cwd: root })).toHaveLength(1);
expect(await listUseCases({ cwd: root })).toHaveLength(1);
expect(showUseCase({ cwd: root, key: created.key }).useCase.frontmatter.title).toBe("Author a use case");
rmSync(root, { recursive: true, force: true });
});
Expand Down