@sentry/warden 0.0.0 → 0.1.1

package/src/cli/output/ink-runner.tsx

@@ -1,5 +1,25 @@
 /**
  * Ink-based skill runner with real-time progress display.
+ *
+ * ## Ink Rendering Constraints
+ *
+ * This file uses Ink (React for CLIs) which has specific constraints that,
+ * if violated, cause duplicate output lines or corrupted display:
+ *
+ * 1. **Single Static component**: Ink's Static uses `position: 'absolute'`.
+ *    Multiple Static components cause layout conflicts. We print the header
+ *    before Ink starts to avoid needing a second Static.
+ *
+ * 2. **Stable item references**: Static tracks items by reference equality.
+ *    Never wrap items in new objects (e.g., `{ type: 'skill', skill }`) on
+ *    each render. Pass the original objects directly.
+ *
+ * 3. **Batched updates**: Rapid consecutive rerender() calls cause duplicate
+ *    output. The updateUI() function batches updates using setImmediate().
+ *
+ * 4. **No direct writes to stderr**: Writing to process.stderr while Ink is
+ *    running corrupts cursor tracking. The onLargePrompt/onPromptSize callbacks
+ *    are exceptions that may cause minor display glitches in edge cases.
  */
 
 import React, { useState, useEffect } from 'react';
@@ -15,11 +35,9 @@ import {
 } from './tasks.js';
 import { formatDuration, truncate, countBySeverity, formatSeverityDot } from './formatters.js';
 import { Verbosity } from './verbosity.js';
-import { ICON_CHECK, ICON_SKIPPED, SPINNER_FRAMES } from './icons.js';
+import { ICON_CHECK, ICON_SKIPPED, ICON_PENDING, ICON_ERROR, SPINNER_FRAMES } from './icons.js';
 import figures from 'figures';
 
-type StaticItem = { type: 'header' } | { type: 'skill'; skill: SkillState };
-
 interface SkillRunnerProps {
   skills: SkillState[];
   completedItems: SkillState[];
@@ -91,7 +109,7 @@ function CompletedSkill({ skill }: { skill: SkillState }): React.ReactElement {
     return (
       <Box flexDirection="column">
         <Box>
-          <Text color="red">{'\u2717'}</Text>
+          <Text color="red">{ICON_ERROR}</Text>
           <Text> {skill.displayName}</Text>
           {duration && <Text dimColor> [{duration}]</Text>}
         </Box>
@@ -127,46 +145,42 @@ function RunningSkill({ skill }: { skill: SkillState }): React.ReactElement {
   );
 }
 
+/**
+ * Renders the skill execution UI.
+ *
+ * IMPORTANT: Ink's Static component tracks items by reference equality.
+ * Items passed to Static must have stable references across renders.
+ * Creating new wrapper objects causes Static to mishandle its internal
+ * state, resulting in duplicate output lines.
+ *
+ * We use a SINGLE Static component to avoid layout conflicts from multiple
+ * absolutely-positioned Static containers.
+ */
 function SkillRunner({ skills, completedItems }: SkillRunnerProps): React.ReactElement {
   const running = skills.filter((s) => s.status === 'running');
   const pending = skills.filter((s) => s.status === 'pending');
 
-  // Build static items: header first, then completed skills
-  const staticItems: StaticItem[] = [
-    { type: 'header' },
-    ...completedItems.map((skill) => ({ type: 'skill' as const, skill })),
-  ];
-
   return (
-    <>
-      {/* Static content: header + completed skills */}
-      <Static items={staticItems}>
-        {(item) => {
-          switch (item.type) {
-            case 'header':
-              return (
-                <Text key="header" bold>
-                  SKILLS
-                </Text>
-              );
-            case 'skill':
-              return <CompletedSkill key={item.skill.name} skill={item.skill} />;
-          }
-        }}
+    <Box flexDirection="column">
+      {/*
+       * Completed skills - passed directly to Static WITHOUT wrapper objects.
+       * completedItems elements have stable references (same objects from parent),
+       * so Ink can correctly track which items are new vs already rendered.
+       */}
+      <Static items={completedItems}>
+        {(skill) => <CompletedSkill key={skill.name} skill={skill} />}
       </Static>
 
-      {/* Dynamic content: running + pending */}
-      <Box flexDirection="column">
-        {running.map((skill) => (
-          <RunningSkill key={skill.name} skill={skill} />
-        ))}
-        {pending.map((skill) => (
-          <Text key={skill.name} dimColor>
-            {'\u25CB'} {skill.displayName}
-          </Text>
-        ))}
-      </Box>
-    </>
+      {/* Dynamic content - updates in place */}
+      {running.map((skill) => (
+        <RunningSkill key={skill.name} skill={skill} />
+      ))}
+      {pending.map((skill) => (
+        <Text key={skill.name} dimColor>
+          {ICON_PENDING} {skill.displayName}
+        </Text>
+      ))}
+    </Box>
   );
 }
 
@@ -206,14 +220,28 @@ export async function runSkillTasksWithInk(
   const completedItems: SkillState[] = [];
   const completedNames = new Set<string>();
 
+  // Print header before Ink starts - this avoids multiple Static components
+  // which can cause layout conflicts due to absolute positioning
+  process.stderr.write('\x1b[1mSKILLS\x1b[0m\n');
+
   // Create Ink instance
   const { rerender, unmount } = render(
     <SkillRunner skills={skillStates} completedItems={completedItems} />,
     { stdout: process.stderr }
   );
 
+  // Batch UI updates to prevent rapid consecutive rerenders that cause duplicate lines.
+  // Without batching, multiple callbacks firing in quick succession (e.g., 5 files
+  // starting simultaneously) trigger 5 immediate rerenders, which Ink cannot
+  // process correctly, resulting in the same line appearing multiple times.
+  let updatePending = false;
   const updateUI = () => {
-    rerender(<SkillRunner skills={[...skillStates]} completedItems={[...completedItems]} />);
+    if (updatePending) return;
+    updatePending = true;
+    setImmediate(() => {
+      updatePending = false;
+      rerender(<SkillRunner skills={[...skillStates]} completedItems={[...completedItems]} />);
+    });
   };
 
   // Callbacks to update state
@@ -297,13 +325,14 @@ export async function runSkillTasksWithInk(
 
       updateUI();
     },
-    // Warn about large prompts - write directly to stderr to avoid Ink interference
+    // CAUTION: Direct stderr writes while Ink is running can cause display glitches.
+    // These callbacks are rare (large prompts, debug mode) so the tradeoff is acceptable.
+    // If these cause issues, consider queueing messages and printing after unmount().
     onLargePrompt: (_skillName, filename, lineRange, chars, estimatedTokens) => {
       const location = `${filename}:${lineRange}`;
       const size = `${Math.round(chars / 1000)}k chars (~${Math.round(estimatedTokens / 1000)}k tokens)`;
       process.stderr.write(`\x1b[33m${figures.warning}\x1b[0m  Large prompt for ${location}: ${size}\n`);
     },
-    // Debug mode: show prompt sizes
     onPromptSize: verbosity >= Verbosity.Debug
       ? (_skillName, filename, lineRange, systemChars, userChars, totalChars, estimatedTokens) => {
           const location = `${filename}:${lineRange}`;

package/src/cli/output/reporter.ts

@@ -13,8 +13,7 @@ import {
 } from './formatters.js';
 import { BoxRenderer } from './box.js';
 import { ICON_CHECK } from './icons.js';
-
-const VERSION = '0.1.0';
+import { getVersion } from '../../utils/index.js';
 
 /**
  * ASCII art logo for TTY header.
@@ -82,10 +81,10 @@ export class Reporter {
       for (const line of LOGO.split('\n')) {
         this.log(chalk.dim(line));
       }
-      this.log(chalk.dim(`v${VERSION}`));
+      this.log(chalk.dim(`v${getVersion()}`));
       this.log('');
     } else {
-      this.logCI(`Warden v${VERSION}`);
+      this.logCI(`Warden v${getVersion()}`);
     }
   }
 

package/src/utils/index.ts

@@ -1,4 +1,5 @@
 export { processInBatches } from './async.js';
+export { getVersion, getMajorVersion } from './version.js';
 
 /** Default concurrency for parallel trigger/skill execution */
 export const DEFAULT_CONCURRENCY = 4;

package/src/utils/version.ts

@@ -0,0 +1,17 @@
+import { readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+let cachedVersion: string | undefined;
+
+export function getVersion(): string {
+  if (cachedVersion) return cachedVersion;
+  const __dirname = dirname(fileURLToPath(import.meta.url));
+  const pkg = JSON.parse(readFileSync(join(__dirname, '..', '..', 'package.json'), 'utf-8')) as { version: string };
+  cachedVersion = pkg.version;
+  return cachedVersion;
+}
+
+export function getMajorVersion(): string {
+  return getVersion().split('.')[0] ?? '0';
+}

package/.claude/settings.local.json

@@ -1,88 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(pnpm build)",
-      "Bash(pnpm install:*)",
-      "Bash(pnpm test:run:*)",
-      "Bash(node dist/cli/index.js:*)",
-      "Bash(pnpm lint:*)",
-      "Bash(echo:*)",
-      "Bash(pnpm add:*)",
-      "Bash(pnpm remove:*)",
-      "Bash(pnpm cli run:*)",
-      "WebSearch",
-      "Bash(pnpm lint:fix:*)",
-      "WebFetch(domain:github.com)",
-      "WebFetch(domain:raw.githubusercontent.com)",
-      "Bash(claude skill:*)",
-      "Bash(curl:*)",
-      "Bash(xxd:*)",
-      "Bash(ANTHROPIC_API_KEY=\"\" node dist/cli/index.js:*)",
-      "Bash(git add:*)",
-      "Bash(git commit:*)",
-      "Bash(grep:*)",
-      "Bash(dex --help:*)",
-      "Bash(npx @zeeg/dex:*)",
-      "Bash(dex config --help:*)",
-      "Bash(dex sync --help:*)",
-      "Bash(dex init:*)",
-      "Bash(dex config:*)",
-      "Bash(dex create:*)",
-      "Bash(dex list:*)",
-      "Bash(pnpm test:*)",
-      "Bash(git rebase:*)",
-      "Bash(pnpm warden:*)",
-      "Bash(node /home/dcramer/src/warden/dist/cli/main.js:*)",
-      "Bash(git stash:*)",
-      "WebFetch(domain:warden.sentry.dev)",
-      "Bash(pnpm cli:*)",
-      "Bash(xargs cat:*)",
-      "Bash(/home/dcramer/src/warden/node_modules/.bin/tsx:*)",
-      "Bash(printf:*)",
-      "Bash(pnpm info:*)",
-      "Bash(npm view:*)",
-      "Bash(npm search:*)",
-      "Bash(pnpm search:*)",
-      "Bash(warden:*)",
-      "Bash(dex show:*)",
-      "Bash(dex complete:*)",
-      "Bash(defined\".\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "Bash(git push)",
-      "Bash(Warden\"\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "Bash(xargs:*)",
-      "Bash(./dist/cli/index.js add:*)",
-      "Bash(./dist/cli/index.js:*)",
-      "Bash(pnpm astro check --help:*)",
-      "Bash(npx astro check:*)",
-      "Bash(pnpm:*)",
-      "Bash(git checkout:*)",
-      "Bash(dex plan:*)",
-      "Bash(git push:*)",
-      "Bash(git -C /home/dcramer/src/warden log --oneline --all -- dist/)",
-      "Bash(git -C /home/dcramer/src/warden status:*)",
-      "WebFetch(domain:www.anthropic.com)",
-      "WebFetch(domain:www.datadoghq.com)",
-      "WebFetch(domain:www.endorlabs.com)",
-      "WebFetch(domain:arize.com)",
-      "WebFetch(domain:platform.openai.com)",
-      "WebFetch(domain:www.promptingguide.ai)",
-      "WebFetch(domain:vercel.com)",
-      "WebFetch(domain:www.npmjs.com)",
-      "Bash(done)",
-      "Bash(failed\" when reviewing Warden output.\n\nRefs #54\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "Bash(git config:*)",
-      "Bash(dex start:*)",
-      "Bash(node:*)",
-      "WebFetch(domain:kudelskisecurity.com)",
-      "Bash(dex edit:*)",
-      "Bash(gh pr create:*)",
-      "Bash(convert:*)",
-      "Bash(git -C /home/dcramer/src/warden log --oneline -5)",
-      "Bash(git -C /home/dcramer/src/warden add:*)",
-      "Bash(git -C /home/dcramer/src/warden commit -m \"$\\(cat <<''EOF''\nchore: Update branding with new warden icons\n\nReplace old icon with new purple and black/white variants. Update\nREADME and docs header to use purple icon, set bw icon as favicon.\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "WebFetch(domain:dex.sentry.dev)",
-      "WebFetch(domain:dex.rip)",
-      "Bash(npm version --help:*)"
-    ]
-  }
-}

package/docs/.claude/settings.local.json

@@ -1,11 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(pnpm build:*)",
-      "Bash(git add:*)",
-      "Bash(git commit -m \"$\\(cat <<''EOF''\ndocs: Add remote skills docs, convert tables to definition lists\n\n- Document warden sync command and --repo flag for remote skills\n- Add skill references section explaining resolution order\n- Add --offline flag and WARDEN_SKILL_CACHE_TTL env var\n- Convert all field reference tables to definition lists\n- Update dl/dt/dd styling for monospace keys with purple color\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "Bash(git commit -m \"$\\(cat <<''EOF''\ndocs\\(config\\): Remove absolute path example from skill references\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")",
-      "Bash(git commit -m \"$\\(cat <<''EOF''\ndocs: Use purple Warden icon for GitHub bot avatar\n\nCo-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>\nEOF\n\\)\")"
-    ]
-  }
-}