#9: more docs

Author: yegor256

.claude/settings.local.json

@@ -1,8 +1,10 @@
 {
   "permissions": {
     "allow": [
-      "Bash(npm test)"
+      "Bash(npm test)",
+      "Bash(npm run lint)",
+      "Bash(npx eslint:*)"
     ],
     "deny": []
   }
-}
+}

src/aibolit.ts

@@ -21,6 +21,12 @@ function check_version(): void {
   }
 }
 
+/**
+ * Analyzes a Java file using Aibolit to find the most critical design issue.
+ * Runs Aibolit static analyzer and returns the highest priority code quality issue.
+ * @param path - The file path to the Java file to analyze
+ * @returns A promise that resolves to a formatted message describing the most critical issue
+ */
 export const aibolit = async function(path: string): Promise<string> {
   check_version();
   if (!fs.existsSync(path)) {

src/safe.ts

@@ -3,6 +3,13 @@
 
 import { to_gpt } from './to_gpt';
 
+/**
+ * Safely executes an async function and returns result or formatted error message.
+ * Wraps function execution in try-catch to handle errors gracefully.
+ * @template T - The return type of the async function
+ * @param f - The async function to execute safely
+ * @returns A promise that resolves to either the function result or a formatted error string
+ */
 export const safe = async function<T>(f: () => Promise<T>): Promise<T | string> {
   try {
     return await f();

src/server.ts

@@ -3,6 +3,10 @@
 
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 
+/**
+ * MCP server instance for the Aibolit MCP Server.
+ * Provides capabilities for tool integration with Aibolit Java code quality analyzer.
+ */
 export const server = new McpServer(
   {
     capabilities: {

src/to_gpt.ts

@@ -1,7 +1,12 @@
 // SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
 // SPDX-License-Identifier: MIT
 
-// Replace all whitespace with a single space and remove spaces before punctuation
+/**
+ * Formats text for GPT consumption by normalizing whitespace and punctuation.
+ * Converts multiple spaces to single spaces and removes spaces before punctuation marks.
+ * @param txt - The input text to format
+ * @returns The formatted text suitable for GPT processing
+ */
 export const to_gpt = function(txt: string): string {
   return txt
     .replace(/\s+/g, ' ')

test/aibolit.test.ts

@@ -181,4 +181,4 @@ describe('aibolit', () => {
       expect(result).toBe('Your code is perfect');
     });
   });
-});
+});