@netanelyasi/agent-ready 0.2.1 → 0.2.3

package/README.md

@@ -14,7 +14,7 @@
 
 <p align="center">
   <img alt="Status" src="https://img.shields.io/badge/status-experimental-f59e0b?style=flat-square" />
-  <img alt="Version" src="https://img.shields.io/badge/version-0.2.0-111827?style=flat-square" />
+  <img alt="Version" src="https://img.shields.io/badge/version-0.2.3-111827?style=flat-square" />
   <img alt="License" src="https://img.shields.io/badge/license-MIT-0f766e?style=flat-square" />
   <img alt="Runtime" src="https://img.shields.io/badge/runtime-Node.js-3c873a?style=flat-square" />
   <img alt="Built by BrainboxAI" src="https://img.shields.io/badge/by-BrainboxAI-111827?style=flat-square" />
@@ -429,7 +429,6 @@ Planned improvements:
 - richer monorepo workspace detection
 - generated `CONTRIBUTING.md` and `SECURITY.md` templates
 - optional AI-assisted repository summary mode
-- npm package release
 - plugin/export presets for Claude Code, Cursor, Codex, and other agents
 - CI mode for failing builds when agent readiness drops below a threshold
 

package/dist/generators/generate.js

@@ -4,7 +4,7 @@ export function generateFiles(scan, score, force) {
     add("CLAUDE.md", generateClaudeMd(scan));
     add("CODEMAP.md", generateCodemap(scan));
     add(".aiignore", generateAiIgnore(scan));
-    add(".claude/settings.json", generateClaudeSettings(scan));
+    add(".claude/settings.json", generateClaudeSettings());
     add(".claude/hooks/prevent-destructive.mjs", generatePreventDestructiveHook());
     add(".claude/hooks/protect-generated.mjs", generateProtectGeneratedHook());
     add(".claude/hooks/suggest-validation.mjs", generateSuggestValidationHook(scan));
@@ -132,6 +132,20 @@ function commandLines(scan) {
         lines.push("- No standard validation commands were detected. Add project-specific commands here.");
     return lines;
 }
+// Flat one-command-per-rule list for the validation skill, e.g. "test: `npm run test`".
+// Unlike commandLines (which nests for CLAUDE.md), this stays flat so it renders
+// correctly as a SKILL.md bullet list.
+function validationSkillRules(scan) {
+    const order = ["dev", "build", "test", "lint", "typecheck", "format"];
+    const rules = [];
+    for (const name of order) {
+        for (const command of (scan.commands[name] ?? []).slice(0, 8))
+            rules.push(`${name}: \`${command}\``);
+    }
+    if (!rules.length)
+        rules.push("No standard validation commands were detected. Add project-specific commands here.");
+    return rules;
+}
 function generateCodemap(scan) {
     return [
         `# ${scan.name} — CODEMAP`,
@@ -228,7 +242,7 @@ function generateAiIgnore(scan) {
         add(`${noisy}/`);
     return `${base.join("\n")}\n`;
 }
-function generateClaudeSettings(scan) {
+function generateClaudeSettings() {
     const deniedPathPatterns = [
         "node_modules/**",
         ".next/**",
@@ -467,7 +481,7 @@ function hookRecommendations(scan) {
 function generateSkills(scan) {
     const skills = [
         { slug: "codebase-navigation", content: skill("codebase-navigation", "Use when starting work in this repository or when a task spans unfamiliar directories.", ["Read CODEMAP.md first.", "Use narrow searches from the relevant directory before global search.", "Prefer symbol/reference search when LSP is available.", "Do not inspect ignored/generated directories unless explicitly needed."]) },
-        { slug: "validation", content: skill("validation", "Use after code edits or before declaring a task complete.", [...commandLines(scan).map((line) => line.replace(/^[- ]+/, "")), "Run the narrowest relevant command first.", "If validation cannot be run, report the exact reason."]) },
+        { slug: "validation", content: skill("validation", "Use after code edits or before declaring a task complete.", [...validationSkillRules(scan), "Run the narrowest relevant command first.", "If validation cannot be run, report the exact reason."]) },
     ];
     if (scan.frameworks.includes("Next.js"))
         skills.push({ slug: "nextjs-hydration", content: skill("nextjs-hydration", "Use when editing Next.js/React components, routes, or client/server boundaries.", ["Do not read localStorage/sessionStorage/window/document during server render or initial state.", "Use useEffect or guarded client-only code for browser APIs.", "Avoid Math.random() or new Date() in render paths that must hydrate identically.", "Keep server/client boundaries explicit."]) });
@@ -480,7 +494,28 @@ function generateSkills(scan) {
     return skills;
 }
 function skill(name, description, rules) {
-    return [`# ${name}`, "", `Description: ${description}`, "", "## Rules", ...rules.map((rule) => `- ${rule}`), ""].join("\n");
+    return [
+        "---",
+        `name: ${name}`,
+        `description: ${yamlScalar(description)}`,
+        "---",
+        "",
+        `# ${name}`,
+        "",
+        description,
+        "",
+        "## Rules",
+        ...rules.map((rule) => `- ${rule}`),
+        "",
+    ].join("\n");
+}
+// Claude Code parses SKILL.md frontmatter as YAML. Quote scalars that contain
+// characters YAML would otherwise treat as structure (`:`, leading `#`, etc.).
+function yamlScalar(value) {
+    if (/^[^\s].*[:#]|^[#&*!|>%@`"']|:\s|\s#/.test(value)) {
+        return `"${value.replaceAll("\\", "\\\\").replaceAll('"', '\\"')}"`;
+    }
+    return value;
 }
 function list(items) {
     return items.length ? items.join(", ") : "none detected";

package/dist/scanner/scanProject.js

@@ -36,7 +36,7 @@ export async function scanProject(rootInput) {
         claudeSettings: await harnessFileState(root, path.join(".claude", "settings.json")),
         skillsDir: await pathExists(path.join(root, ".agent-ready", "skills")) || await pathExists(path.join(root, ".claude", "skills")),
     };
-    const codeGraph = await analyzeCodeGraph(root, files, packages);
+    const codeGraph = await analyzeCodeGraph(root, files, packages, frameworks);
     return {
         root,
         name: rootPackage?.name ?? path.basename(root),
@@ -107,6 +107,8 @@ function detectFrameworks(files, deps) {
         found.add(deps.nuxt ? "Nuxt" : "Vue");
     if (deps.svelte || deps["@sveltejs/kit"])
         found.add(deps["@sveltejs/kit"] ? "SvelteKit" : "Svelte");
+    if (deps["@remix-run/react"] || deps["@remix-run/node"] || deps["@remix-run/server-runtime"] || files.includes("remix.config.js") || files.includes("remix.config.ts"))
+        found.add("Remix");
     if (deps.vite || files.some((file) => file.startsWith("vite.config.")))
         found.add("Vite");
     if (deps.express)
@@ -267,7 +269,7 @@ async function harnessFileState(root, relativePath) {
     const generatedByAgentReady = Boolean(text && /generated by `?agent-ready`?|agent-ready:|Generated by agent-ready/i.test(text));
     return { exists: true, generatedByAgentReady, countsAsMaintainerAuthored: !generatedByAgentReady };
 }
-async function analyzeCodeGraph(root, files, packages) {
+async function analyzeCodeGraph(root, files, packages, frameworks) {
     const sourceFiles = files
         .filter((file) => /\.(tsx?|jsx?|mjs|cjs|py|go|rs|svelte)$/.test(file))
         .filter((file) => !file.endsWith(".d.ts"))
@@ -275,7 +277,7 @@ async function analyzeCodeGraph(root, files, packages) {
         .slice(0, 2000);
     const sourceSet = new Set(sourceFiles.map((file) => rel(root, file)));
     const goModulePath = await readGoModulePath(root);
-    const entryPoints = detectEntryPoints(root, packages, sourceSet);
+    const entryPoints = detectEntryPoints(root, packages, sourceSet, frameworks);
     const importEdges = [];
     const externalImportMap = new Map();
     for (const file of sourceFiles) {
@@ -323,7 +325,7 @@ async function analyzeCodeGraph(root, files, packages) {
         unresolvedRelativeImports: importEdges.filter((edge) => !edge.resolved).slice(0, 30),
     };
 }
-function detectEntryPoints(root, packages, sourceSet) {
+function detectEntryPoints(root, packages, sourceSet, frameworks) {
     const entries = new Map();
     for (const pkg of packages) {
         const dir = path.posix.dirname(pkg.path) === "." ? "." : path.posix.dirname(pkg.path);
@@ -360,7 +362,7 @@ function detectEntryPoints(root, packages, sourceSet) {
             if (!source.startsWith(packageRoot))
                 continue;
             const local = source.slice(packageRoot.length);
-            const frameworkEntry = frameworkEntryPoint(local);
+            const frameworkEntry = frameworkEntryPoint(local, frameworks);
             if (frameworkEntry)
                 entries.set(source, { path: source, ...frameworkEntry });
             if (/^cmd\/[^/]+\/main\.go$/.test(local))
@@ -376,32 +378,42 @@ function detectEntryPoints(root, packages, sourceSet) {
     }
     return [...entries.values()].sort((a, b) => a.path.localeCompare(b.path)).slice(0, 40);
 }
-function frameworkEntryPoint(localPath) {
-    if (/^(src\/)?app\/(page|layout|route)\.(tsx?|jsx?)$/.test(localPath)) {
-        const file = localPath.includes("/layout.") ? "layout" : localPath.includes("/route.") ? "route handler" : "page";
-        return { kind: `Next.js ${file}`, reason: "App Router root entry" };
+function frameworkEntryPoint(localPath, frameworks) {
+    // Framework conventions like `pages/` and `app/` are generic folder names that
+    // also appear in Vite/React-Router apps. Only treat them as framework entry
+    // points when the framework is actually detected, or every such project is
+    // mislabeled (e.g. a Vite `src/pages/*.tsx` reported as a Next.js route).
+    if (frameworks.includes("Next.js")) {
+        if (/^(src\/)?app\/(page|layout|route)\.(tsx?|jsx?)$/.test(localPath)) {
+            const file = localPath.includes("/layout.") ? "layout" : localPath.includes("/route.") ? "route handler" : "page";
+            return { kind: `Next.js ${file}`, reason: "App Router root entry" };
+        }
+        if (/^(src\/)?app\/.+\/(page|layout|route|loading|error|not-found)\.(tsx?|jsx?)$/.test(localPath)) {
+            return { kind: "Next.js route", reason: "App Router route segment entry" };
+        }
+        if (/^(src\/)?pages\/index\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "Next.js route", reason: "Pages Router index" };
+        if (/^(src\/)?pages\/(api\/.+|.+)\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "Next.js route", reason: "Pages Router route/API entry" };
+        if (/^(src\/)?middleware\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "Next.js middleware", reason: "Next.js request middleware entry" };
+        if (/^next\.config\.(tsx?|jsx?|mjs|cjs)$/.test(localPath))
+            return { kind: "Next.js config", reason: "Next.js configuration entry" };
+    }
+    if (frameworks.includes("Remix")) {
+        if (/^app\/(root|entry\.(client|server))\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "Remix entry", reason: "Remix root/client/server entry" };
+        if (/^app\/routes\/.+\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "Remix route", reason: "Remix route module" };
     }
-    if (/^(src\/)?app\/.+\/(page|layout|route|loading|error|not-found)\.(tsx?|jsx?)$/.test(localPath)) {
-        return { kind: "Next.js route", reason: "App Router route segment entry" };
+    if (frameworks.includes("SvelteKit")) {
+        if (/^src\/routes\/(\+page|\+layout|\+server)\.(svelte|tsx?|jsx?)$/.test(localPath))
+            return { kind: "SvelteKit route", reason: "SvelteKit root route entry" };
+        if (/^src\/routes\/.+\/(\+page|\+layout|\+server)\.(svelte|tsx?|jsx?)$/.test(localPath))
+            return { kind: "SvelteKit route", reason: "SvelteKit route entry" };
+        if (/^src\/hooks(\.server)?\.(tsx?|jsx?)$/.test(localPath))
+            return { kind: "SvelteKit hook", reason: "SvelteKit lifecycle hook entry" };
     }
-    if (/^(src\/)?pages\/index\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "Next.js route", reason: "Pages Router index" };
-    if (/^(src\/)?pages\/(api\/.+|.+)\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "Next.js route", reason: "Pages Router route/API entry" };
-    if (/^(src\/)?middleware\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "Next.js middleware", reason: "Next.js request middleware entry" };
-    if (/^next\.config\.(tsx?|jsx?|mjs|cjs)$/.test(localPath))
-        return { kind: "Next.js config", reason: "Next.js configuration entry" };
-    if (/^app\/(root|entry\.(client|server))\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "Remix entry", reason: "Remix root/client/server entry" };
-    if (/^app\/routes\/.+\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "Remix route", reason: "Remix route module" };
-    if (/^src\/routes\/(\+page|\+layout|\+server)\.(svelte|tsx?|jsx?)$/.test(localPath))
-        return { kind: "SvelteKit route", reason: "SvelteKit root route entry" };
-    if (/^src\/routes\/.+\/(\+page|\+layout|\+server)\.(svelte|tsx?|jsx?)$/.test(localPath))
-        return { kind: "SvelteKit route", reason: "SvelteKit route entry" };
-    if (/^src\/hooks(\.server)?\.(tsx?|jsx?)$/.test(localPath))
-        return { kind: "SvelteKit hook", reason: "SvelteKit lifecycle hook entry" };
     return undefined;
 }
 function extractImportSpecifiers(text, from) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netanelyasi/agent-ready",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Generate an AI-agent harness for any codebase: CLAUDE.md, CODEMAP.md, skills, ignore rules, and readiness reports.",
   "type": "module",
   "bin": {