autodocsync 1.0.1 → 1.1.0

package/bin/index.js

@@ -12,6 +12,7 @@ import {
 import {
   describeEndpointWithMistral,
   summarizeProjectWithMistral,
+  generateREADMEWithMistral,
 } from "../src/llm.js";
 import { generateOpenAPI } from "../src/openapi-gen.js";
 
@@ -100,6 +101,13 @@ program
       console.log(
         `[docSync] SUCCESS: openapi.json generated at ${path.join(outDir, "openapi.json")}`,
       );
+
+      console.log("[docSync] Projecting professional README.md with Mistral...");
+      const readmeContent = await generateREADMEWithMistral(openApiSpec);
+      fs.writeFileSync(path.join(outDir, "README.md"), readmeContent, "utf-8");
+      console.log(
+        `[docSync] SUCCESS: README.md generated at ${path.join(outDir, "README.md")}`,
+      );
     } else {
       console.log(
         "[docSync] Generating openapi.json (without AI enhancement)...",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "autodocsync",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Combines TS code parsing and local LLMs to generate OpenAPI specs automatically",
   "main": "src/openapi-gen.js",
   "type": "module",

package/src/llm.js

@@ -3,19 +3,19 @@ import axios from "axios";
 export async function describeEndpointWithMistral(endpoint) {
   const method = endpoint.method.toUpperCase();
   const url = endpoint.url;
-  
+
   // Extract the resource from the URL (e.g., /users, /posts, /comments)
   const resourceMatch = url.match(/\/([a-zA-Z]+)(\?|$|\/{1})/);
-  const resource = resourceMatch ? resourceMatch[1] : 'resource';
-  
+  const resource = resourceMatch ? resourceMatch[1] : "resource";
+
   try {
     // Try to use Ollama HTTP API
     const prompt = `As a Senior API Architect, generate a highly professional, detailed description for this API endpoint. Explain its purpose and its role in the system. Use industry-standard terminology.\n\nMethod: ${method}\nURL: ${url}\n\nReturn only the description text.`;
-    
-    const response = await axios.post('http://localhost:11434/api/generate', {
-      model: 'mistral',
+
+    const response = await axios.post("http://localhost:11434/api/generate", {
+      model: "mistral",
       prompt: prompt,
-      stream: false
+      stream: false,
     });
 
     const data = response.data;
@@ -30,10 +30,10 @@ export async function describeEndpointWithMistral(endpoint) {
 export async function summarizeProjectWithMistral(readme) {
   try {
     const prompt = `Based on this README, generate a brief (1-2 sentences), professional description of this project for API documentation:\n\n${readme.slice(0, 3000)}`;
-    const response = await axios.post('http://localhost:11434/api/generate', {
-      model: 'mistral',
+    const response = await axios.post("http://localhost:11434/api/generate", {
+      model: "mistral",
       prompt: prompt,
-      stream: false
+      stream: false,
     });
 
     const data = response.data;
@@ -44,13 +44,63 @@ export async function summarizeProjectWithMistral(readme) {
   }
 }
 
+export async function generateREADMEWithMistral(openApiSpec) {
+  try {
+    const prompt = `As a Visionary Technical Architect and documentation specialist, generate an "Ultra-Premium" (Vercel/Linear-tier) README.md file for the following API project.
+
+Project Name: ${openApiSpec.info.title}
+Project Goal: ${openApiSpec.info.description}
+
+---
+
+## 🏗️ High-Level Structuring Instructions:
+
+1.  **Header**: Premium title with dynamic-looking badges (License, Node.js version, Tech used).
+2.  **The Vision**: A high-impact executive summary and a "The Problem vs. The Solution" section illustrating why this project matters.
+3.  **Real-Time Architecture**: Provide a high-quality Mermaid.js diagram illustrating the core logic and flow of the API.
+4.  **Premium Feature Grid**: Use a clear, sophisticated layout to list key features with professional, benefit-driven copy.
+5.  **Tech Stack**: List all core technologies (Node.js, Express, etc.).
+6.  **Interactive API Documentation**: Generate a clean, comprehensive "API Reference" table with Path, Method, and Description.
+7.  **The Golden Path (Quick Start)**: A copy-paste ready installation and usage section designed for zero friction.
+8.  **Development & Roadmap**: Sections for contributors, including a vision for future improvements.
+9.  **Premium Formatting**: Use GitHub-style "Alerts" (> [!TIP], > [!NOTE]) and professional hierarchy throughout.
+
+---
+
+## Technical Context (OpenAPI 3.0):
+${JSON.stringify(openApiSpec, null, 2).slice(0, 6000)}
+
+---
+
+**CRITICAL**: Return ONLY the Markdown content. Do not add conversational text or wrap in code blocks. Make it look better than any standard technical README. Focus on clarity, aesthetics, and developer experience.`;
+
+    const response = await axios.post("http://localhost:11434/api/generate", {
+      model: "mistral",
+      prompt: prompt,
+      stream: false,
+    });
+
+    const data = response.data;
+    return (
+      data.response?.trim() ||
+      "# " + openApiSpec.info.title + "\n\nGenerated API documentation."
+    );
+  } catch (error) {
+    console.error("[llm] Failed to generate README:", error.message);
+    return "# " + openApiSpec.info.title + "\n\nGenerated API documentation.";
+  }
+}
+
 function generateDefaultDescription(method, resource, url) {
   const descriptions = {
-    'GET': `Retrieves ${resource} data from the server.`,
-    'POST': `Creates a new ${resource.slice(0, -1) || 'resource'} and returns the created object.`,
-    'PUT': `Updates an existing ${resource.slice(0, -1) || 'resource'} with the provided data.`,
-    'DELETE': `Permanently deletes the specified ${resource.slice(0, -1) || 'resource'} from the server.`,
-    'PATCH': `Partially updates a ${resource.slice(0, -1) || 'resource'} with the provided changes.`
+    GET: `Retrieves ${resource} data from the server.`,
+    POST: `Creates a new ${resource.slice(0, -1) || "resource"} and returns the created object.`,
+    PUT: `Updates an existing ${resource.slice(0, -1) || "resource"} with the provided data.`,
+    DELETE: `Permanently deletes the specified ${resource.slice(0, -1) || "resource"} from the server.`,
+    PATCH: `Partially updates a ${resource.slice(0, -1) || "resource"} with the provided changes.`,
   };
-  return descriptions[method] || `Performs a ${method} request to the ${resource} endpoint.`;
+  return (
+    descriptions[method] ||
+    `Performs a ${method} request to the ${resource} endpoint.`
+  );
 }