docit-ai 1.0.0

package/src/formatter/index.ts

@@ -0,0 +1,110 @@
+import type { DocumentationResult } from "../ai/engine.js";
+import * as fs from "fs";
+import * as path from "path";
+
+/**
+ * Formatter Module
+ * Generates the DOCIT.md documentation file with the three-view hierarchy.
+ */
+
+export interface FormatterOptions {
+  outputPath?: string;
+  projectName?: string;
+}
+
+export function formatDocumentation(
+  results: DocumentationResult[],
+  options: FormatterOptions = {},
+): string {
+  const projectName = options.projectName ?? "Project";
+  const timestamp = new Date().toISOString().split("T")[0];
+
+  const strategicContent =
+    results.find((r) => r.view === "strategic")?.content ?? "";
+  const technicalContent =
+    results.find((r) => r.view === "technical")?.content ?? "";
+  const personalContent =
+    results.find((r) => r.view === "personal")?.content ?? "";
+
+  const doc = `# ${projectName} Documentation
+
+> Auto-generated by Docit on ${timestamp}
+
+---
+
+## Table of Contents
+
+1. [PM Dashboard (Strategic View)](#pm-dashboard-strategic-view)
+2. [Developer Reference (Technical View)](#developer-reference-technical-view)
+3. [Personal Roadmap (Individual View)](#personal-roadmap-individual-view)
+
+---
+
+# PM Dashboard (Strategic View)
+
+*For Project Managers and Stakeholders*
+
+${strategicContent}
+
+---
+
+# Developer Reference (Technical View)
+
+*For Developers and Engineers*
+
+${technicalContent}
+
+---
+
+# Personal Roadmap (Individual View)
+
+*For Solo Developers and Contributors*
+
+${personalContent}
+
+---
+
+## Changelog
+
+| Date | Changes |
+|------|---------|
+| ${timestamp} | Documentation generated |
+
+---
+
+*Generated by [Docit](https://github.com/docit) - Your AI-powered documentation companion*
+`;
+
+  return doc;
+}
+
+export function writeDocumentation(
+  content: string,
+  outputPath: string = "./DOCIT.md",
+): void {
+  const absolutePath = path.resolve(outputPath);
+  fs.writeFileSync(absolutePath, content, "utf-8");
+}
+
+export function appendToChangelog(
+  existingContent: string,
+  newEntry: string,
+): string {
+  const changelogPattern =
+    /## Changelog\n\n\| Date \| Changes \|\n\|------\|---------\|\n/;
+  const match = existingContent.match(changelogPattern);
+
+  if (match) {
+    const insertPosition = (match.index ?? 0) + match[0].length;
+    const timestamp = new Date().toISOString().split("T")[0];
+    const newRow = `| ${timestamp} | ${newEntry} |\n`;
+
+    return (
+      existingContent.slice(0, insertPosition) +
+      newRow +
+      existingContent.slice(insertPosition)
+    );
+  }
+
+  return existingContent;
+}

package/src/index.ts

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+
+/**
+ * Docit - AI-powered documentation generator
+ * Entry point for the CLI application
+ */
+
+import { createCli } from "./cli/index.js";
+
+const program = createCli();
+program.parse(process.argv);

package/src/parser/extractor.ts

@@ -0,0 +1,211 @@
+import Parser from "tree-sitter";
+import TypeScript from "tree-sitter-typescript";
+import * as fs from "fs";
+
+/**
+ * Parser Module
+ * Uses tree-sitter to extract "Code Skeletons" from TypeScript files.
+ */
+
+export interface CodeSkeleton {
+  name: string;
+  kind: "function" | "class" | "interface" | "type" | "variable" | "export";
+  signature: string;
+  parameters?: string[] | undefined;
+  returnType?: string | undefined;
+  comments?: string | undefined;
+  startLine: number;
+  endLine: number;
+}
+
+export interface FileAnalysis {
+  filePath: string;
+  skeletons: CodeSkeleton[];
+  todos: string[];
+}
+
+const parser = new Parser();
+parser.setLanguage(TypeScript.typescript);
+
+function extractComments(
+  node: Parser.SyntaxNode,
+  sourceCode: string,
+): string | undefined {
+  // Look for preceding comments
+  let sibling = node.previousNamedSibling;
+  while (sibling && sibling.type === "comment") {
+    const commentText = sourceCode.slice(sibling.startIndex, sibling.endIndex);
+    return commentText
+      .replace(/^\/\*\*?|\*\/$/g, "")
+      .replace(/^\s*\* ?/gm, "")
+      .trim();
+  }
+  return undefined;
+}
+
+function extractTodos(sourceCode: string): string[] {
+  const todoPattern = /\/\/\s*TODO[:\s](.+)|\/\*\s*TODO[:\s](.+?)\*\//gi;
+  const todos: string[] = [];
+  let match;
+
+  while ((match = todoPattern.exec(sourceCode)) !== null) {
+    todos.push((match[1] ?? match[2] ?? "").trim());
+  }
+
+  return todos;
+}
+
+function getNodeText(
+  node: Parser.SyntaxNode | null,
+  sourceCode: string,
+): string {
+  if (!node) return "";
+  return sourceCode.slice(node.startIndex, node.endIndex);
+}
+
+function extractFunctionSkeleton(
+  node: Parser.SyntaxNode,
+  sourceCode: string,
+): CodeSkeleton {
+  const nameNode = node.childForFieldName("name");
+  const paramsNode = node.childForFieldName("parameters");
+  const returnTypeNode = node.childForFieldName("return_type");
+
+  const parameters = paramsNode
+    ? getNodeText(paramsNode, sourceCode)
+        .replace(/^\(|\)$/g, "")
+        .split(",")
+        .map((p) => p.trim())
+        .filter((p) => p.length > 0)
+    : [];
+
+  return {
+    name: nameNode ? getNodeText(nameNode, sourceCode) : "anonymous",
+    kind: "function",
+    signature: `function ${getNodeText(nameNode, sourceCode)}${getNodeText(paramsNode, sourceCode)}${returnTypeNode ? ": " + getNodeText(returnTypeNode, sourceCode).replace(/^:\s*/, "") : ""}`,
+    parameters,
+    returnType: returnTypeNode
+      ? getNodeText(returnTypeNode, sourceCode).replace(/^:\s*/, "")
+      : undefined,
+    comments: extractComments(node, sourceCode),
+    startLine: node.startPosition.row + 1,
+    endLine: node.endPosition.row + 1,
+  };
+}
+
+function extractClassSkeleton(
+  node: Parser.SyntaxNode,
+  sourceCode: string,
+): CodeSkeleton {
+  const nameNode = node.childForFieldName("name");
+
+  return {
+    name: nameNode ? getNodeText(nameNode, sourceCode) : "AnonymousClass",
+    kind: "class",
+    signature: `class ${getNodeText(nameNode, sourceCode)}`,
+    comments: extractComments(node, sourceCode),
+    startLine: node.startPosition.row + 1,
+    endLine: node.endPosition.row + 1,
+  };
+}
+
+function extractInterfaceSkeleton(
+  node: Parser.SyntaxNode,
+  sourceCode: string,
+): CodeSkeleton {
+  const nameNode = node.childForFieldName("name");
+
+  return {
+    name: nameNode ? getNodeText(nameNode, sourceCode) : "AnonymousInterface",
+    kind: "interface",
+    signature: `interface ${getNodeText(nameNode, sourceCode)}`,
+    comments: extractComments(node, sourceCode),
+    startLine: node.startPosition.row + 1,
+    endLine: node.endPosition.row + 1,
+  };
+}
+
+function extractTypeSkeleton(
+  node: Parser.SyntaxNode,
+  sourceCode: string,
+): CodeSkeleton {
+  const nameNode = node.childForFieldName("name");
+
+  return {
+    name: nameNode ? getNodeText(nameNode, sourceCode) : "AnonymousType",
+    kind: "type",
+    signature: `type ${getNodeText(nameNode, sourceCode)}`,
+    comments: extractComments(node, sourceCode),
+    startLine: node.startPosition.row + 1,
+    endLine: node.endPosition.row + 1,
+  };
+}
+
+export function extractSkeletons(sourceCode: string): CodeSkeleton[] {
+  const tree = parser.parse(sourceCode);
+  const skeletons: CodeSkeleton[] = [];
+
+  function traverse(node: Parser.SyntaxNode) {
+    switch (node.type) {
+      case "function_declaration":
+      case "arrow_function":
+      case "method_definition":
+        skeletons.push(extractFunctionSkeleton(node, sourceCode));
+        break;
+      case "class_declaration":
+        skeletons.push(extractClassSkeleton(node, sourceCode));
+        break;
+      case "interface_declaration":
+        skeletons.push(extractInterfaceSkeleton(node, sourceCode));
+        break;
+      case "type_alias_declaration":
+        skeletons.push(extractTypeSkeleton(node, sourceCode));
+        break;
+      case "export_statement":
+        // Handle exported declarations
+        for (const child of node.children) {
+          traverse(child);
+        }
+        return; // Don't traverse children again
+    }
+
+    for (const child of node.children) {
+      traverse(child);
+    }
+  }
+
+  traverse(tree.rootNode);
+  return skeletons;
+}
+
+export function analyzeFile(filePath: string): FileAnalysis {
+  const sourceCode = fs.readFileSync(filePath, "utf-8");
+
+  return {
+    filePath,
+    skeletons: extractSkeletons(sourceCode),
+    todos: extractTodos(sourceCode),
+  };
+}
+
+export function formatSkeletonForLLM(analysis: FileAnalysis): string {
+  const lines: string[] = [`File: ${analysis.filePath}`, "---"];
+
+  for (const skeleton of analysis.skeletons) {
+    lines.push(`[${skeleton.kind.toUpperCase()}] ${skeleton.signature}`);
+    if (skeleton.comments) {
+      lines.push(`  Comment: ${skeleton.comments}`);
+    }
+    lines.push(`  Lines: ${skeleton.startLine}-${skeleton.endLine}`);
+    lines.push("");
+  }
+
+  if (analysis.todos.length > 0) {
+    lines.push("TODOs:");
+    for (const todo of analysis.todos) {
+      lines.push(`  - ${todo}`);
+    }
+  }
+
+  return lines.join("\n");
+}

package/src/scanner/index.ts

@@ -0,0 +1,49 @@
+import { simpleGit, type SimpleGit } from "simple-git";
+import * as path from "path";
+
+/**
+ * Scanner Module
+ * Uses simple-git to identify files modified in the last commit.
+ */
+
+export interface ChangedFile {
+  path: string;
+  status: string;
+}
+
+export async function getChangedFiles(
+  repoPath: string = ".",
+): Promise<ChangedFile[]> {
+  const git: SimpleGit = simpleGit(repoPath);
+
+  try {
+    // Get the diff of the last commit
+    const diffSummary = await git.diffSummary(["HEAD~1", "HEAD"]);
+
+    const changedFiles: ChangedFile[] = diffSummary.files.map((file) => ({
+      path: path.resolve(repoPath, file.file),
+      status: "binary" in file ? "binary" : "modified",
+    }));
+
+    return changedFiles;
+  } catch {
+    // If there's no previous commit, get all tracked files
+    const status = await git.status();
+    const allFiles = [...status.modified, ...status.created, ...status.staged];
+
+    return [...new Set(allFiles)].map((filePath) => ({
+      path: path.resolve(repoPath, filePath),
+      status: "new",
+    }));
+  }
+}
+
+export async function getModifiedTypeScriptFiles(
+  repoPath: string = ".",
+): Promise<string[]> {
+  const changedFiles = await getChangedFiles(repoPath);
+
+  return changedFiles
+    .filter((file) => file.path.endsWith(".ts") || file.path.endsWith(".tsx"))
+    .map((file) => file.path);
+}

package/tsconfig.json

@@ -0,0 +1,43 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "lib": ["esnext"],
+    "types": ["node"],
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "server"]
+}