legacyver 3.1.0 → 3.4.0

package/legacyver-docs/src/llm/free-model.md

@@ -1,40 +0,0 @@
-## Overview
-The `applyFreeModelPolicy` function applies free model policies to a given configuration object. It checks if the model ID ends with `:free` and adjusts the configuration accordingly.
-
-## Functions
-### applyFreeModelPolicy
-#### Description
-Applies free model policies to a given configuration object.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | Object | The configuration object to apply free model policies to |
-
-#### Return Value
-The mutated configuration object
-
-#### Complex Logic
-The function checks if the provider is one of Ollama, Groq, Gemini, or Kimi, and if so, sets `isFreeModel` and `skipCostEstimation` to `true`. It then checks the provider-specific rate limits and caps concurrency accordingly. If the model ID does not end with `:free`, it sets `isFreeModel` to `false`. Otherwise, it sets `isFreeModel` to `true` and caps concurrency to 2.
-
-#### Detected Patterns
-* Arithmetic operations (e.g. `parseInt`, `parseInt(config.concurrency) || 1`)
-* Conditional statements (e.g. `if (provider === 'ollama' || provider === 'groq' || provider === 'gemini' || provider === 'kimi')`)
-* String manipulation (e.g. `provider.toLowerCase()`, `model.endsWith(':free')`)
-
-## Dependencies
-* `../utils/logger`
-* `picocolors`
-
-## Usage Example
-```javascript
-const config = {
-  provider: 'groq',
-  model: 'meta-llama/llama-3.3-70b-instruct:free',
-  concurrency: 5
-};
-
-const updatedConfig = applyFreeModelPolicy(config);
-console.log(updatedConfig);
-```
-Note: This example is a simplified representation of the usage and may not cover all possible scenarios.

package/legacyver-docs/src/llm/index.md

@@ -1,29 +0,0 @@
-## Overview
-This module exports a `createProvider` function that returns an instance of a provider based on the provided configuration.
-
-## Functions
-### createProvider
-#### Description
-Returns an instance of a provider based on the provided configuration.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | Object | The configuration object |
-
-#### Return Value
-An instance of `OpenRouterProvider`, `OllamaProvider`, `GroqProvider`, `GeminiProvider`, or `KimiProvider`
-
-## Dependencies
-* `./providers/openrouter: OpenRouterProvider`
-* `./providers/ollama: OllamaProvider`
-* `./providers/groq: GroqProvider`
-* `./providers/gemini: GeminiProvider`
-* `./providers/kimi: KimiProvider`
-
-## Usage Example
-Based on the code, it appears that the `createProvider` function can be used as follows:
-```javascript
-const provider = createProvider({ provider: 'openrouter' });
-```
-This would return an instance of `OpenRouterProvider` with the provided configuration.

package/legacyver-docs/src/llm/prompts.md

@@ -1,150 +0,0 @@
-## Overview
-This module exports two functions: `buildUserMessage` and `SYSTEM_PROMPT`. The `buildUserMessage` function generates a user message for a single file, while `SYSTEM_PROMPT` contains the instructions for generating documentation.
-
-## Functions
-
-### stripEmpty
-#### Description
-Removes null/undefined values and empty arrays from an object (shallow).
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| obj | Object | The object to strip |
-
-#### Return Value
-The stripped object
-
-#### Body
-```javascript
-function stripEmpty(obj) {
-  const result = {};
-  for (const [k, v] of Object.entries(obj)) {
-    if (v === null || v === undefined) continue;
-    if (Array.isArray(v) && v.length === 0) continue;
-    result[k] = v;
-  }
-  return result;
-}
-```
-The function iterates over the object's entries using `Object.entries()`. If a value is null or undefined, it skips to the next iteration. If a value is an empty array, it also skips to the next iteration. Otherwise, it adds the key-value pair to the result object.
-
-### slimFacts
-#### Description
-Builds a slim version of FileFacts for the prompt — remove noise, keep signal.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fileFacts | Object | The FileFacts object to slim |
-
-#### Return Value
-The slimmed FileFacts object
-
-#### Body
-```javascript
-function slimFacts(fileFacts) {
-  const slim = {
-    file: fileFacts.relativePath,
-    lang: fileFacts.language,
-    lines: fileFacts.linesOfCode,
-  };
-
-  // Functions — only include useful fields
-  if (fileFacts.functions && fileFacts.functions.length > 0) {
-    slim.functions = fileFacts.functions.map(fn => {
-      const entry = { name: fn.name };
-      if (fn.params && fn.params.length > 0) {
-        entry.params = fn.params.map(p => p.type ? `${p.name}:${p.type}` : p.name);
-      }
-      if (fn.returnType) entry.returns = fn.returnType;
-      if (fn.isExported) entry.exported = true;
-      if (fn.isAsync) entry.async = true;
-      if (fn.complexityClass && fn.complexityClass !== 'simple') {
-        entry.complexity = fn.complexityClass;
-      }
-      if (fn.detectedPatterns && fn.detectedPatterns.length > 0) {
-        entry.patterns = fn.detectedPatterns;
-      }
-      if (fn.bodySnippet) entry.body = fn.bodySnippet;
-      if (fn.calls && fn.calls.length > 0) entry.calls = fn.calls;
-      return entry;
-    });
-  }
-
-  // Classes
-  if (fileFacts.classes && fileFacts.classes.length > 0) {
-    slim.classes = fileFacts.classes.map(c => {
-      const entry = { name: c.name };
-      if (c.superClass) entry.extends = c.superClass;
-      if (c.methods && c.methods.length > 0) entry.methods = c.methods.map(m => m.name || m);
-      return entry;
-    });
-  }
-
-  // Imports — compact
-  if (fileFacts.imports && fileFacts.imports.length > 0) {
-    slim.imports = fileFacts.imports.map(i => {
-      if (i.specifiers && i.specifiers.length > 0) {
-        return `${i.module}: ${i.specifiers.join(', ')}`;
-      }
-      return i.module;
-    });
-  }
-
-  // Exports
-  if (fileFacts.exports && fileFacts.exports.length > 0) {
-    slim.exports = fileFacts.exports;
-  }
-
-  return slim;
-}
-```
-The function creates a slim version of the FileFacts object by removing unnecessary fields and transforming others. It iterates over the functions, classes, imports, and exports of the FileFacts object and creates a new object with only the necessary fields.
-
-### buildUserMessage
-#### Description
-Build the user message for a single file.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fileFacts | Object | The FileFacts object |
-| rawSource | string | The raw source code |
-
-#### Return Value
-The user message as a string
-
-#### Body
-```javascript
-function buildUserMessage(fileFacts, rawSource) {
-  const slim = slimFacts(fileFacts);
-
-  // Truncate source to ~150 lines to keep prompt small
-  const lines = rawSource.split('\n');
-  let source = rawSource;
-  if (lines.length > 150) {
-    source = lines.slice(0, 150).join('\n') + '\n// ... truncated';
-  }
-
-  return `STRUCTURE:
-${JSON.stringify(slim)}
-
-CODE:
-${source}
-
-Generate documentation following the system instructions.`;
-}
-```
-The function calls `slimFacts` to create a slim version of the FileFacts object. It then truncates the source code to ~150 lines and returns a string containing the slimmed FileFacts object and the truncated source code.
-
-## Dependencies
-* `Object.entries`
-* `Array.isArray`
-* `JSON.stringify`
-* `split`
-* `slice`
-* `join`
-
-## Usage Example
-No clear pattern is visible in the code.

package/legacyver-docs/src/llm/providers/gemini.md

@@ -1,51 +0,0 @@
-## Overview
-The GeminiProvider class is a language model provider that interacts with the Gemini API to generate content. It handles API key management, model selection, and error handling.
-
-## Functions
-
-### constructor(config)
-Initializes a new instance of the GeminiProvider class.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| config | object | Configuration object containing API key and model settings |
-
-#### Returns
-None
-
-#### Throws
-NoApiKeyError if no API key is provided
-
-### complete(chunk)
-Generates content using the Gemini API.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| chunk | object | Chunk object containing system prompt and user message |
-
-#### Returns
-Object containing generated content and usage metadata
-
-### estimateCost()
-Estimates the cost of using the GeminiProvider. Currently, it always returns 0.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| None |  |  |
-
-#### Returns
-Number representing the estimated cost
-
-## Dependencies
-
-* `../../utils/errors: NoApiKeyError`
-* `../../utils/errors: RateLimitError`
-
-## Usage Example
-```javascript
-const GeminiProvider = require('./gemini');
-const provider = new GeminiProvider({ geminiApiKey: 'YOUR_API_KEY' });
-provider.complete({ systemPrompt: 'Hello', userMessage: 'World' })
-  .then((result) => console.log(result.content))
-  .catch((error) => console.error(error.message));
-```

package/legacyver-docs/src/llm/providers/groq.md

@@ -1,76 +0,0 @@
-## Overview
-The GroqProvider class is a provider for the Groq API, allowing users to interact with the API for text completion and estimation of costs.
-
-## Functions
-### GroqProvider
-#### Description
-The GroqProvider class is a constructor that initializes the provider with a configuration object.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | object | The configuration object containing the provider's settings. |
-
-#### Return Value
-None
-
-#### Parameters Table
-| Name | Type | Description |
-| --- | --- | --- |
-| config | object | The configuration object containing the provider's settings. |
-
-#### Return Value
-None
-
-### complete
-#### Description
-The complete method sends a request to the Groq API to complete a text based on a system prompt and user message.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| chunk | object | The object containing the system prompt and user message. |
-
-#### Return Value
-An object containing the completed text and tokens used.
-
-#### Parameters Table
-| Name | Type | Description |
-| --- | --- | --- |
-| chunk | object | The object containing the system prompt and user message. |
-
-#### Return Value
-An object containing the completed text and tokens used.
-
-### estimateCost
-#### Description
-The estimateCost method returns an estimate of the cost of using the Groq API.
-
-#### Parameters
-None
-
-#### Return Value
-The estimated cost of using the Groq API.
-
-#### Parameters Table
-None
-
-#### Return Value
-The estimated cost of using the Groq API.
-
-## Dependencies
-* `../../utils/errors: NoApiKeyError`
-* `../../utils/errors: RateLimitError`
-
-## Usage Example
-```javascript
-const GroqProvider = require('./groq');
-const provider = new GroqProvider({ groqApiKey: 'your_api_key' });
-const chunk = { systemPrompt: 'Hello, how are you?', userMessage: 'I am good, thanks.' };
-provider.complete(chunk).then((result) => {
-  console.log(result.content);
-  console.log(result.tokensUsed);
-}).catch((error) => {
-  console.error(error);
-});
-```

package/legacyver-docs/src/llm/providers/kimi.md

@@ -1,48 +0,0 @@
-## Overview
-The KimiProvider class is a language model provider that interacts with the Kimi API to generate text completions. It handles authentication, rate limiting, and error handling.
-
-## Functions
-### constructor(config)
-#### Description
-Initializes a new instance of the KimiProvider class.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | object | Configuration object containing API key and model settings |
-
-#### Return Value
-None
-
-### complete(chunk)
-#### Description
-Generates a text completion using the Kimi API.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| chunk | object | Object containing system prompt and user message |
-
-#### Return Value
-Object containing generated content and tokens used
-
-### estimateCost()
-#### Description
-Estimates the cost of using the Kimi API. (Note: This function always returns 0, indicating that the cost is unknown or not applicable.)
-
-#### Parameters
-None
-
-#### Return Value
-Number (always 0)
-
-## Dependencies
-* `../../utils/errors: NoApiKeyError`
-* `../../utils/errors: RateLimitError`
-
-## Usage Example
-```javascript
-const kimiProvider = new KimiProvider({ kimiApiKey: 'YOUR_API_KEY' });
-const completion = await kimiProvider.complete({ systemPrompt: 'Hello, ', userMessage: 'world!' });
-console.log(completion.content); // Output: 'Hello, world!'
-```

package/legacyver-docs/src/llm/providers/ollama.md

@@ -1,50 +0,0 @@
-## Overview
-The OllamaProvider class is a JavaScript module that provides a provider for the Ollama large language model. It allows for completing text prompts and estimating the cost of using the model.
-
-## Functions
-### constructor(config)
-#### Description
-Initializes a new instance of the OllamaProvider class.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | object | Configuration object with a `model` property |
-
-#### Return Value
-None
-
-### complete(chunk)
-#### Description
-Completes a text prompt using the Ollama model.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| chunk | object | Object with `systemPrompt` and `userMessage` properties |
-
-#### Return Value
-Object with `content` and `tokensUsed` properties
-
-### estimateCost()
-#### Description
-Estimates the cost of using the Ollama model. (Note: this function always returns 0)
-
-#### Parameters
-None
-
-#### Return Value
-Number (always 0)
-
-## Dependencies
-* `../../utils/logger: logger`
-
-## Usage Example
-Based on the code, a usage example can be inferred:
-```javascript
-const OllamaProvider = require('./ollama');
-const provider = new OllamaProvider({ model: 'llama3.2' });
-provider.complete({ systemPrompt: 'Hello, ', userMessage: 'world!' })
-  .then((result) => console.log(result.content))
-  .catch((error) => console.error(error));
-```

package/legacyver-docs/src/llm/providers/openrouter.md

@@ -1,55 +0,0 @@
-## Overview
-The OpenRouterProvider class is a provider for the OpenRouter API, allowing for completion of text based on a given prompt.
-
-## Functions
-### constructor(config)
-#### Description
-Initializes a new instance of the OpenRouterProvider class.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| config | object | Configuration object |
-
-#### Return Value
-None
-
-#### Throws
-* NoApiKeyError if no API key is provided
-
-### complete(chunk)
-#### Description
-Completes a text based on a given prompt using the OpenRouter API.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| chunk | object | Object containing system prompt and user message |
-
-#### Return Value
-Object containing completed content and tokens used
-
-### estimateCost(inputTokens, outputTokens)
-#### Description
-Estimates the cost of completing a text based on input and output tokens.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| inputTokens | number | Number of input tokens |
-| outputTokens | number | Number of output tokens |
-
-#### Return Value
-Number representing estimated cost (0 if using free model)
-
-## Dependencies
-*../../utils/errors: NoApiKeyError, RateLimitError
-*../../utils/logger: logger
-
-## Usage Example
-```javascript
-const provider = new OpenRouterProvider({ apiKey: 'YOUR_API_KEY' });
-const chunk = { systemPrompt: 'Hello, world!', userMessage: 'How are you?' };
-const result = await provider.complete(chunk);
-console.log(result.content);
-```

package/legacyver-docs/src/llm/queue.md

@@ -1,41 +0,0 @@
-## Overview
-The `createQueue` function processes chunks through an LLM provider with concurrency and retry, returning an array of DocFragment objects.
-
-## Functions
-### createQueue
-#### Description
-Process chunks through the LLM provider with concurrency and retry.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| chunks | Array | The chunks to process |
-| provider | Object | The LLM provider |
-| config | Object | The configuration object |
-| callbacks | Object | The callbacks object with `onProgress` and `onError` properties |
-
-#### Return Value
-Promise<Array> DocFragment[]
-
-#### Body Logic
-The function uses `pLimit` to limit concurrency and `pRetry` to retry failed attempts. It maps over the chunks, processing each one with the `limit` function. If the provider's `complete` method fails, it waits for the retry-after period before retrying. If all retries fail, it logs an error and pushes a failed DocFragment to the result array.
-
-## Dependencies
-* `p-limit: pLimit`
-* `p-retry: pRetry`
-* `../utils/logger: logger`
-
-## Usage Example
-```javascript
-const createQueue = require('./queue');
-const provider = require('./provider');
-const config = require('./config');
-const callbacks = {
-  onProgress: () => console.log('Progress'),
-  onError: (error, chunk) => console.error(`Error processing ${chunk.relativePath}: ${error.message}`)
-};
-
-const chunks = [...]; // array of chunks to process
-const result = await createQueue(chunks, provider, config, callbacks);
-console.log(result); // array of DocFragment objects
-```

package/legacyver-docs/src/llm/re-prompter.md

@@ -1,33 +0,0 @@
-## Overview
-The `reprompt` function re-prompt the LLM for missing exports in a file based on the provided `fragment`, `fileFacts`, `provider`, and `config`.
-
-## Functions
-### reprompt
-#### Description
-Re-prompt the LLM for missing exports.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fragment | Object | The file fragment to re-prompt. |
-| fileFacts | Object | The file facts containing exported symbols. |
-| provider | Object | The provider to complete the re-prompt. |
-| config | Object | The configuration for the re-prompt. |
-
-#### Return Value
-A Promise that resolves to the updated fragment or null if no missing exports are found.
-
-## Dependencies
-* `./prompts`: SYSTEM_PROMPT
-* `../utils/logger`: logger
-
-## Usage Example
-The `reprompt` function can be used to re-prompt the LLM for missing exports in a file. For example:
-```javascript
-const fragment = { content: '...' };
-const fileFacts = { exports: ['sym1', 'sym2'] };
-const provider = { complete: async () => {... } };
-const config = {... };
-
-const updatedFragment = await reprompt(fragment, fileFacts, provider, config);
-```

package/legacyver-docs/src/llm/validator.md

@@ -1,34 +0,0 @@
-## Overview
-The `validateFragment` function is a post-generation quality validator that checks for hallucinations and completeness in LLM output. It takes a fragment object and file facts as input and returns an object with hallucinations, missing exports, and a passed status.
-
-## Functions
-### validateFragment
-#### Description
-Validates a fragment of code by checking for hallucinations and completeness.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fragment | Object | The fragment to be validated, containing `relativePath` and `content` properties. |
-| fileFacts | Object | The file facts object containing information about the file, such as functions, classes, imports, and exports. |
-
-#### Return Value
-An object with the following properties:
-| Name | Type | Description |
-| --- | --- | --- |
-| hallucinations | string[] | An array of suspected hallucinations. |
-| missingExports | string[] | An array of exported symbols not mentioned in the LLM output. |
-| passed | boolean | A boolean indicating whether the validation passed (true) or failed (false). |
-
-## Dependencies
-* `../utils/logger: logger`
-
-## Usage Example
-The `validateFragment` function can be used to validate a fragment of code by calling it with a fragment object and file facts as arguments. For example:
-```javascript
-const fragment = { relativePath: 'path/to/file.js', content: '...' };
-const fileFacts = { functions: [...], classes: [...], imports: [...], exports: [...] };
-const result = validateFragment(fragment, fileFacts);
-console.log(result);
-```
-Note that this example is not a direct usage example from the code, but rather a hypothetical example to illustrate how the function can be used.

package/legacyver-docs/src/parser/ast/generic.md

@@ -1,34 +0,0 @@
-## Overview
-The `parse` function is a generic regex-based fallback parser for unsupported languages. It takes in `sourceText`, `relativePath`, and `language` as parameters and returns an object containing parsed data.
-
-## Functions
-### parse
-#### Description
-Parses the source code and extracts function, import, and class definitions.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code to parse. |
-| relativePath | string | The relative path of the source code. |
-| language | string | The language of the source code (optional). |
-
-#### Return Value
-An object containing the following properties:
-* `relativePath`: The relative path of the source code.
-* `language`: The language of the source code (or 'unknown' if not specified).
-* `linesOfCode`: The number of lines in the source code.
-* `functions`: An array of function definitions.
-* `classes`: An array of class definitions.
-* `imports`: An array of import statements.
-* `exports`: An array of exported function names.
-* `callsTo`: An array of called functions (not populated in this implementation).
-* `calledBy`: An array of functions that call other functions (not populated in this implementation).
-* `hash`: A hash value (not populated in this implementation).
-* `parserType`: The type of parser used (in this case, 'generic').
-
-## Dependencies
-* `../../utils/logger`: The logger utility.
-
-## Usage Example
-No clear usage example is visible in the code. The `parse` function is exported as a module, but there is no example of how to use it.