@compilr-dev/agents-coding-ts 0.1.2 → 0.1.4

package/dist/tools/get-type-hierarchy.d.ts

@@ -4,8 +4,8 @@
  * Analyze the inheritance hierarchy of a class or interface.
  * Shows ancestors (parents) and descendants (children) in the type tree.
  */
-import type { Tool } from '@compilr-dev/agents';
-import type { GetTypeHierarchyInput, HierarchyDirection } from './types.js';
+import type { Tool } from "@compilr-dev/agents";
+import type { GetTypeHierarchyInput, HierarchyDirection } from "./types.js";
 /**
  * getTypeHierarchy tool - Analyze type inheritance
  */

package/dist/tools/get-type-hierarchy.js

@@ -4,53 +4,58 @@
  * Analyze the inheritance hierarchy of a class or interface.
  * Shows ancestors (parents) and descendants (children) in the type tree.
  */
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
-import * as ts from 'typescript';
-import { defineTool, createSuccessResult, createErrorResult } from '@compilr-dev/agents';
-import { detectLanguage, isLanguageSupported } from '../parser/typescript-parser.js';
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import * as ts from "typescript";
+import { defineTool, createSuccessResult, createErrorResult, } from "@compilr-dev/agents";
+import { detectLanguage, isLanguageSupported, } from "../parser/typescript-parser.js";
 // Tool description
 const TOOL_DESCRIPTION = `Analyze the inheritance hierarchy of a class or interface.
 Returns the type's ancestors (what it extends/implements) and descendants (what extends/implements it).
 Useful for understanding class hierarchies and interface relationships.`;
 // Tool input schema
 const TOOL_INPUT_SCHEMA = {
-    type: 'object',
+    type: "object",
     properties: {
         name: {
-            type: 'string',
-            description: 'Class or interface name to analyze',
+            type: "string",
+            description: "Class or interface name to analyze",
         },
         file: {
-            type: 'string',
-            description: 'File where the type is defined (improves accuracy)',
+            type: "string",
+            description: "File where the type is defined (improves accuracy)",
         },
         direction: {
-            type: 'string',
-            enum: ['ancestors', 'descendants', 'both'],
+            type: "string",
+            enum: ["ancestors", "descendants", "both"],
             description: 'Direction: "ancestors" | "descendants" | "both" (default: "both")',
-            default: 'both',
+            default: "both",
         },
         maxDepth: {
-            type: 'number',
-            description: 'Maximum depth to traverse (default: 5)',
+            type: "number",
+            description: "Maximum depth to traverse (default: 5)",
             default: 5,
         },
         scope: {
-            type: 'string',
-            description: 'Scope directory for searching descendants (default: current directory)',
+            type: "string",
+            description: "Scope directory for searching descendants (default: current directory)",
         },
     },
-    required: ['name'],
+    required: ["name"],
 };
 // Default file patterns
-const DEFAULT_INCLUDE = ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx'];
-const DEFAULT_EXCLUDE = ['**/node_modules/**', '**/dist/**', '**/build/**', '**/.git/**'];
+const DEFAULT_INCLUDE = ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx"];
+const DEFAULT_EXCLUDE = [
+    "**/node_modules/**",
+    "**/dist/**",
+    "**/build/**",
+    "**/.git/**",
+];
 /**
  * getTypeHierarchy tool - Analyze type inheritance
  */
 export const getTypeHierarchyTool = defineTool({
-    name: 'get_type_hierarchy',
+    name: "get_type_hierarchy",
     description: TOOL_DESCRIPTION,
     inputSchema: TOOL_INPUT_SCHEMA,
     execute: executeGetTypeHierarchy,
@@ -59,10 +64,10 @@ export const getTypeHierarchyTool = defineTool({
  * Execute the getTypeHierarchy tool
  */
 async function executeGetTypeHierarchy(input) {
-    const { name, file, direction = 'both', maxDepth = 5, scope = '.' } = input;
+    const { name, file, direction = "both", maxDepth = 5, scope = "." } = input;
     // Validate input
     if (!name || name.trim().length === 0) {
-        return createErrorResult('Type name is required');
+        return createErrorResult("Type name is required");
     }
     try {
         // Resolve scope path
@@ -116,9 +121,9 @@ async function executeGetTypeHierarchy(input) {
             // Return empty result if type not found
             const emptyRoot = {
                 name,
-                path: '',
+                path: "",
                 line: 0,
-                kind: 'class',
+                kind: "class",
                 exported: false,
             };
             const result = {
@@ -136,13 +141,13 @@ async function executeGetTypeHierarchy(input) {
         const allTypes = [];
         let maxDepthReached = 0;
         const rootNode = createTypeNode(targetType);
-        if (direction === 'ancestors' || direction === 'both') {
+        if (direction === "ancestors" || direction === "both") {
             const { ancestors, depth } = buildAncestors(targetType, typeMap, maxDepth, 0);
             rootNode.parents = ancestors;
             if (depth > maxDepthReached)
                 maxDepthReached = depth;
         }
-        if (direction === 'descendants' || direction === 'both') {
+        if (direction === "descendants" || direction === "both") {
             const { descendants, depth } = buildDescendants(targetType, typeMap, maxDepth, 0);
             rootNode.children = descendants;
             if (depth > maxDepthReached)
@@ -213,9 +218,9 @@ function buildAncestors(type, typeMap, maxDepth, currentDepth) {
             // External type (not found in codebase)
             ancestors.push({
                 name: parentName,
-                path: '',
+                path: "",
                 line: 0,
-                kind: 'interface', // Assume interface for unknown types
+                kind: "interface", // Assume interface for unknown types
                 exported: true,
             });
         }
@@ -285,7 +290,7 @@ function collectAllTypes(node, allTypes) {
  */
 async function extractTypeInfo(filePath) {
     try {
-        const content = await fs.readFile(filePath, 'utf-8');
+        const content = await fs.readFile(filePath, "utf-8");
         const detection = detectLanguage(filePath);
         if (!detection.language) {
             return [];
@@ -293,7 +298,7 @@ async function extractTypeInfo(filePath) {
         if (!isLanguageSupported(detection.language)) {
             return [];
         }
-        const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true, filePath.endsWith('.tsx') ? ts.ScriptKind.TSX : ts.ScriptKind.TS);
+        const sourceFile = ts.createSourceFile(filePath, content, ts.ScriptTarget.Latest, true, filePath.endsWith(".tsx") ? ts.ScriptKind.TSX : ts.ScriptKind.TS);
         const types = [];
         const visit = (node) => {
             // Class declarations
@@ -330,8 +335,10 @@ function extractClassInfo(node, sourceFile, filePath) {
     if (!node.name)
         return null;
     const { line } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ?? false;
-    const isAbstract = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.AbstractKeyword) ?? false;
+    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ??
+        false;
+    const isAbstract = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.AbstractKeyword) ??
+        false;
     const extendsTypes = [];
     const implementsTypes = [];
     if (node.heritageClauses) {
@@ -352,7 +359,7 @@ function extractClassInfo(node, sourceFile, filePath) {
         name: node.name.text,
         path: filePath,
         line: line + 1,
-        kind: 'class',
+        kind: "class",
         isAbstract,
         exported: isExported,
         extends: extendsTypes.length > 0 ? extendsTypes : undefined,
@@ -364,7 +371,8 @@ function extractClassInfo(node, sourceFile, filePath) {
  */
 function extractInterfaceInfo(node, sourceFile, filePath) {
     const { line } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ?? false;
+    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ??
+        false;
     const extendsTypes = [];
     if (node.heritageClauses) {
         for (const clause of node.heritageClauses) {
@@ -379,7 +387,7 @@ function extractInterfaceInfo(node, sourceFile, filePath) {
         name: node.name.text,
         path: filePath,
         line: line + 1,
-        kind: 'interface',
+        kind: "interface",
         exported: isExported,
         extends: extendsTypes.length > 0 ? extendsTypes : undefined,
     };
@@ -389,7 +397,8 @@ function extractInterfaceInfo(node, sourceFile, filePath) {
  */
 function extractTypeAliasInfo(node, sourceFile, filePath) {
     const { line } = sourceFile.getLineAndCharacterOfPosition(node.getStart());
-    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ?? false;
+    const isExported = node.modifiers?.some((m) => m.kind === ts.SyntaxKind.ExportKeyword) ??
+        false;
     // Extract types from intersection type
     const extendsTypes = [];
     if (ts.isIntersectionTypeNode(node.type)) {
@@ -411,7 +420,7 @@ function extractTypeAliasInfo(node, sourceFile, filePath) {
         name: node.name.text,
         path: filePath,
         line: line + 1,
-        kind: 'type',
+        kind: "type",
         exported: isExported,
         extends: extendsTypes,
     };
@@ -432,9 +441,9 @@ async function collectFiles(dirPath, include, exclude, maxDepth, maxFiles, curre
             const relativePath = fullPath;
             // Check exclusions
             const isExcluded = exclude.some((pattern) => {
-                if (pattern.includes('**')) {
-                    const simplePattern = pattern.replace(/\*\*/g, '');
-                    return relativePath.includes(simplePattern.replace(/\*/g, ''));
+                if (pattern.includes("**")) {
+                    const simplePattern = pattern.replace(/\*\*/g, "");
+                    return relativePath.includes(simplePattern.replace(/\*/g, ""));
                 }
                 return entry.name === pattern || relativePath.includes(pattern);
             });
@@ -447,8 +456,8 @@ async function collectFiles(dirPath, include, exclude, maxDepth, maxFiles, curre
             else if (entry.isFile()) {
                 // Check if file matches include patterns
                 const isIncluded = include.some((pattern) => {
-                    if (pattern.includes('*')) {
-                        const ext = pattern.replace('**/', '').replace('*', '');
+                    if (pattern.includes("*")) {
+                        const ext = pattern.replace("**/", "").replace("*", "");
                         return entry.name.endsWith(ext);
                     }
                     return entry.name === pattern;
@@ -469,7 +478,7 @@ async function collectFiles(dirPath, include, exclude, maxDepth, maxFiles, curre
  */
 export function createGetTypeHierarchyTool(options) {
     return defineTool({
-        name: options?.name ?? 'get_type_hierarchy',
+        name: options?.name ?? "get_type_hierarchy",
         description: options?.description ?? TOOL_DESCRIPTION,
         inputSchema: TOOL_INPUT_SCHEMA,
         execute: async (input) => {

package/dist/tools/index.d.ts

@@ -5,19 +5,21 @@
  * These tools reduce token usage by returning structured JSON
  * instead of requiring the agent to read and reason through raw code.
  */
-export { getFileStructureTool, createGetFileStructureTool } from './get-file-structure.js';
-export { findSymbolTool, createFindSymbolTool } from './find-symbol.js';
-export { findReferencesTool, createFindReferencesTool } from './find-references.js';
-export { getImportsTool, createGetImportsTool } from './get-imports.js';
-export { getExportsTool, createGetExportsTool } from './get-exports.js';
-export { getCallGraphTool, createGetCallGraphTool } from './get-call-graph.js';
-export { getDependencyGraphTool, createGetDependencyGraphTool } from './get-dependency-graph.js';
-export { findImplementationsTool, createFindImplementationsTool } from './find-implementations.js';
-export { getTypeHierarchyTool, createGetTypeHierarchyTool } from './get-type-hierarchy.js';
-export { getComplexityTool, createGetComplexityTool } from './get-complexity.js';
-export { findDeadCodeTool, createFindDeadCodeTool } from './find-dead-code.js';
-export { findDuplicatesTool, createFindDuplicatesTool } from './find-duplicates.js';
-export { findPatternsTool, createFindPatternsTool } from './find-patterns.js';
-export { getSignatureTool, createGetSignatureTool } from './get-signature.js';
-export { getDocumentationTool, createGetDocumentationTool } from './get-documentation.js';
-export type { SupportedLanguage, ParameterInfo, GetFileStructureInput, FileStructure, ImportInfo, ExportInfo, ClassInfo, FunctionInfo, MethodInfo, PropertyInfo, VariableInfo, TypeDefinitionInfo, FileStats, SymbolKind, SymbolKindFilter, FindSymbolInput, FindSymbolResult, SymbolDefinition, SearchStats, ReferenceType, FindReferencesInput, FindReferencesResult, Reference, FileReferences, GetImportsInput, GetImportsResult, DetailedImport, ImportedSymbol, TransitiveImport, ImportStats, GetExportsInput, GetExportsResult, ExportedSymbol, ExportKind, ReExport, ExportStats, CallGraphDirection, CallType, GetCallGraphInput, GetCallGraphResult, FunctionNode, CallInfo, CallGraphNode, CallGraphStats, GetDependencyGraphInput, GetDependencyGraphResult, ModuleNode, DependencyEdge, CircularDependency, DependencyGraphStats, FindImplementationsInput, FindImplementationsResult, ImplementationInfo, HierarchyDirection, GetTypeHierarchyInput, GetTypeHierarchyResult, TypeHierarchyNode, GetComplexityInput, GetComplexityResult, FileComplexity, FunctionComplexity, ComplexityContributor, ComplexityContributorType, FindDeadCodeInput, FindDeadCodeResult, DeadCodeItem, FindDuplicatesInput, FindDuplicatesResult, DuplicateGroup, CodeLocation, FindPatternsInput, FindPatternsResult, PatternMatch, CodePattern, GetSignatureInput, GetSignatureResult, ParameterDetail, TypeDetail, GenericDetail, Documentation, MemberSignature, SignatureSymbolKind, GetDocumentationInput, GetDocumentationResult, FileDocumentation, DocumentedSymbol, DocumentationSymbolKind, ExtractorOptions, } from './types.js';
+export { getFileStructureTool, createGetFileStructureTool, } from "./get-file-structure.js";
+export { findSymbolTool, createFindSymbolTool } from "./find-symbol.js";
+export { findReferencesTool, createFindReferencesTool, } from "./find-references.js";
+export { getImportsTool, createGetImportsTool } from "./get-imports.js";
+export { getExportsTool, createGetExportsTool } from "./get-exports.js";
+export { getCallGraphTool, createGetCallGraphTool } from "./get-call-graph.js";
+export { getDependencyGraphTool, createGetDependencyGraphTool, } from "./get-dependency-graph.js";
+export { findImplementationsTool, createFindImplementationsTool, } from "./find-implementations.js";
+export { getTypeHierarchyTool, createGetTypeHierarchyTool, } from "./get-type-hierarchy.js";
+export { getComplexityTool, createGetComplexityTool, } from "./get-complexity.js";
+export { findDeadCodeTool, createFindDeadCodeTool } from "./find-dead-code.js";
+export { findDuplicatesTool, createFindDuplicatesTool, } from "./find-duplicates.js";
+export { findPatternsTool, createFindPatternsTool } from "./find-patterns.js";
+export { getSignatureTool, createGetSignatureTool } from "./get-signature.js";
+export { getDocumentationTool, createGetDocumentationTool, } from "./get-documentation.js";
+export { readFunctionTool, readClassTool, readTypeTool, createReadFunctionTool, createReadClassTool, createReadTypeTool, } from "./read-symbol.js";
+export type { SupportedLanguage, ParameterInfo, GetFileStructureInput, FileStructure, ImportInfo, ExportInfo, ClassInfo, FunctionInfo, MethodInfo, PropertyInfo, VariableInfo, TypeDefinitionInfo, FileStats, SymbolKind, SymbolKindFilter, FindSymbolInput, FindSymbolResult, SymbolDefinition, SearchStats, ReferenceType, FindReferencesInput, FindReferencesResult, Reference, FileReferences, GetImportsInput, GetImportsResult, DetailedImport, ImportedSymbol, TransitiveImport, ImportStats, GetExportsInput, GetExportsResult, ExportedSymbol, ExportKind, ReExport, ExportStats, CallGraphDirection, CallType, GetCallGraphInput, GetCallGraphResult, FunctionNode, CallInfo, CallGraphNode, CallGraphStats, GetDependencyGraphInput, GetDependencyGraphResult, ModuleNode, DependencyEdge, CircularDependency, DependencyGraphStats, FindImplementationsInput, FindImplementationsResult, ImplementationInfo, HierarchyDirection, GetTypeHierarchyInput, GetTypeHierarchyResult, TypeHierarchyNode, GetComplexityInput, GetComplexityResult, FileComplexity, FunctionComplexity, ComplexityContributor, ComplexityContributorType, FindDeadCodeInput, FindDeadCodeResult, DeadCodeItem, FindDuplicatesInput, FindDuplicatesResult, DuplicateGroup, CodeLocation, FindPatternsInput, FindPatternsResult, PatternMatch, CodePattern, GetSignatureInput, GetSignatureResult, ParameterDetail, TypeDetail, GenericDetail, Documentation, MemberSignature, SignatureSymbolKind, GetDocumentationInput, GetDocumentationResult, FileDocumentation, DocumentedSymbol, DocumentationSymbolKind, ExtractorOptions, } from "./types.js";
+export type { ReadFunctionInput, ReadClassInput, ReadTypeInput, ReadSymbolResult, } from "./read-symbol.js";

package/dist/tools/index.js

@@ -6,20 +6,22 @@
  * instead of requiring the agent to read and reason through raw code.
  */
 // Tier 1 & 2 Tools
-export { getFileStructureTool, createGetFileStructureTool } from './get-file-structure.js';
-export { findSymbolTool, createFindSymbolTool } from './find-symbol.js';
-export { findReferencesTool, createFindReferencesTool } from './find-references.js';
-export { getImportsTool, createGetImportsTool } from './get-imports.js';
-export { getExportsTool, createGetExportsTool } from './get-exports.js';
-export { getCallGraphTool, createGetCallGraphTool } from './get-call-graph.js';
-export { getDependencyGraphTool, createGetDependencyGraphTool } from './get-dependency-graph.js';
-export { findImplementationsTool, createFindImplementationsTool } from './find-implementations.js';
-export { getTypeHierarchyTool, createGetTypeHierarchyTool } from './get-type-hierarchy.js';
+export { getFileStructureTool, createGetFileStructureTool, } from "./get-file-structure.js";
+export { findSymbolTool, createFindSymbolTool } from "./find-symbol.js";
+export { findReferencesTool, createFindReferencesTool, } from "./find-references.js";
+export { getImportsTool, createGetImportsTool } from "./get-imports.js";
+export { getExportsTool, createGetExportsTool } from "./get-exports.js";
+export { getCallGraphTool, createGetCallGraphTool } from "./get-call-graph.js";
+export { getDependencyGraphTool, createGetDependencyGraphTool, } from "./get-dependency-graph.js";
+export { findImplementationsTool, createFindImplementationsTool, } from "./find-implementations.js";
+export { getTypeHierarchyTool, createGetTypeHierarchyTool, } from "./get-type-hierarchy.js";
 // Tier 3 Tools
-export { getComplexityTool, createGetComplexityTool } from './get-complexity.js';
-export { findDeadCodeTool, createFindDeadCodeTool } from './find-dead-code.js';
-export { findDuplicatesTool, createFindDuplicatesTool } from './find-duplicates.js';
-export { findPatternsTool, createFindPatternsTool } from './find-patterns.js';
+export { getComplexityTool, createGetComplexityTool, } from "./get-complexity.js";
+export { findDeadCodeTool, createFindDeadCodeTool } from "./find-dead-code.js";
+export { findDuplicatesTool, createFindDuplicatesTool, } from "./find-duplicates.js";
+export { findPatternsTool, createFindPatternsTool } from "./find-patterns.js";
 // Tier 4 Utility Tools
-export { getSignatureTool, createGetSignatureTool } from './get-signature.js';
-export { getDocumentationTool, createGetDocumentationTool } from './get-documentation.js';
+export { getSignatureTool, createGetSignatureTool } from "./get-signature.js";
+export { getDocumentationTool, createGetDocumentationTool, } from "./get-documentation.js";
+// Smart File Reading Tools (token-efficient code extraction)
+export { readFunctionTool, readClassTool, readTypeTool, createReadFunctionTool, createReadClassTool, createReadTypeTool, } from "./read-symbol.js";

package/dist/tools/read-symbol.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Smart File Reading Tools
+ *
+ * AST-aware tools that extract specific code elements by name,
+ * returning exact source code without guessing line numbers.
+ *
+ * Tools:
+ * - read_function: Read a function/method by name
+ * - read_class: Read a class by name
+ * - read_type: Read a type/interface by name
+ */
+import type { Tool } from "@compilr-dev/agents";
+export interface ReadFunctionInput {
+    /** Absolute path to the file */
+    path: string;
+    /** Function or method name to read */
+    name: string;
+    /** Class name if reading a method (optional) */
+    className?: string;
+    /** Include JSDoc comment (default: true) */
+    includeJsDoc?: boolean;
+}
+export interface ReadClassInput {
+    /** Absolute path to the file */
+    path: string;
+    /** Class name to read */
+    name: string;
+    /** What to include: 'full' | 'signature' | 'methods-only' | 'properties-only' */
+    include?: "full" | "signature" | "methods-only" | "properties-only";
+    /** Include JSDoc comment (default: true) */
+    includeJsDoc?: boolean;
+}
+export interface ReadTypeInput {
+    /** Absolute path to the file */
+    path: string;
+    /** Type or interface name to read */
+    name: string;
+    /** Include JSDoc comment (default: true) */
+    includeJsDoc?: boolean;
+}
+export interface ReadSymbolResult {
+    /** Symbol name */
+    name: string;
+    /** Symbol kind */
+    kind: "function" | "method" | "class" | "interface" | "type" | "enum";
+    /** Start line (1-based) */
+    startLine: number;
+    /** End line (1-based) */
+    endLine: number;
+    /** Source code content */
+    content: string;
+    /** Signature (for functions/methods/classes) */
+    signature?: string;
+    /** Containing class (for methods) */
+    container?: string;
+}
+export declare const readFunctionTool: Tool<ReadFunctionInput>;
+export declare const readClassTool: Tool<ReadClassInput>;
+export declare const readTypeTool: Tool<ReadTypeInput>;
+export declare function createReadFunctionTool(): Tool<ReadFunctionInput>;
+export declare function createReadClassTool(): Tool<ReadClassInput>;
+export declare function createReadTypeTool(): Tool<ReadTypeInput>;