legacyver 3.1.0 → 3.4.0

package/legacyver-docs/src/parser/body-extractor.md

@@ -1,34 +0,0 @@
-## Overview
-The `body-extractor` module exports a single function, `extractBodySnippet`, which extracts a body snippet from a given source text based on line start and end positions.
-
-## Functions
-### extractBodySnippet
-Extracts a body snippet from source text given line start/end positions.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to extract the body snippet from. |
-| lineStart | number | The 1-indexed line number to start the body snippet from. |
-| lineEnd | number | The 1-indexed line number to end the body snippet at. |
-| complexityScore | number | The complexity score of the function (not used in the function). |
-
-Returns:
-| Type | Description |
-| --- | --- |
-| { bodySnippet: string|null, bodySnippetTruncated: boolean } | An object containing the extracted body snippet and a boolean indicating whether the snippet was truncated. |
-
-## Dependencies
-* `MAX_BODY_LINES` (a constant)
-
-## Usage Example
-```javascript
-const sourceText = 'function foo() {\n  console.log("Hello World!");\n  console.log("This is a test.");\n}';
-const lineStart = 1;
-const lineEnd = 2;
-const complexityScore = 5;
-
-const result = extractBodySnippet(sourceText, lineStart, lineEnd, complexityScore);
-console.log(result.bodySnippet);
-console.log(result.bodySnippetTruncated);
-```
-Note: The usage example is not explicitly shown in the code, but it can be inferred based on the function signature and the logic of the function.

package/legacyver-docs/src/parser/call-graph.md

@@ -1,45 +0,0 @@
-## Overview
-This module exports a function `buildCallGraph` that constructs a cross-file call graph by resolving import paths.
-
-## Functions
-
-### buildCallGraph
-Builds a cross-file call graph by resolving import paths.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| allFacts | array | An array of facts containing relative paths and import information |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| allFacts | array | The input array with call graph information added |
-
-### resolveImport
-Resolves an import path by searching for matching files in the file map.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| modulePath | string | The import path to resolve |
-| fromPath | string | The path from which to resolve the import |
-| fileMap | Map | A map of file paths to facts |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| resolved | string | The resolved import path, or null if not found |
-
-## Dependencies
-* `Map`
-* `set`
-* `of`
-* `resolveImport`
-* `includes`
-* `push`
-* `get`
-
-## Usage Example
-```javascript
-const allFacts = [...]; // array of facts
-const callGraph = buildCallGraph(allFacts);
-console.log(callGraph);
-```
-Note: A clear usage example is not visible in the code, so this section is empty.

package/legacyver-docs/src/parser/complexity-scorer.md

@@ -1,25 +0,0 @@
-## Overview
-The `scoreComplexity` function scores a function's complexity based on its body text using heuristics.
-
-## Functions
-### scoreComplexity
-Scores a function's complexity based on its body text.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| bodyText | string | Raw source of the function body |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| { complexityScore: number, complexityClass: string, detectedPatterns: string[] } | object | Complexity score, class, and detected patterns |
-
-## Dependencies
-* `./pattern-detector` (imported as `DOMAIN_PATTERNS`)
-
-## Usage Example
-The code snippet below demonstrates how to use the `scoreComplexity` function:
-```javascript
-const complexityScore = scoreComplexity('function example() { /* code */ }');
-console.log(complexityScore);
-```
-Note: This example is not directly visible in the code, but it can be inferred based on the function's signature and usage.

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

@@ -1,59 +0,0 @@
-## Overview
-This module exports two functions, `parseFile` and `parseFiles`, which are used to parse files and assemble a Package (PKG) respectively.
-
-## Functions
-
-### parseFile
-Dispatch parsing to the appropriate language parser.
-
-#### Description
-This function takes a `fileManifest` object and a `meta` object as input, and returns a `FileFacts` object.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fileManifest | `import('../crawler/index').FileManifest` | File metadata |
-| meta | `Object` | Project metadata (includes framework) |
-
-#### Return Value
-`FileFacts` object
-
-#### Body Logic
-The function first tries to read the file using `readFileSync`. If successful, it dispatches parsing to the appropriate language parser using the `PARSERS` object. If the language is not supported, it falls back to the generic parser. The parsed facts are then enriched with Laravel-specific information if the language is PHP and the framework is Laravel.
-
-### parseFiles
-Parse all files and assemble the PKG.
-
-#### Description
-This function takes an array of `fileManifest` objects, a `meta` object, and a `config` object as input, and returns a `PKG` object.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| files | `import('../crawler/index').FileManifest[]` | Array of file metadata |
-| meta | `Object` | Project metadata |
-| config | `Object` | Configuration object |
-
-#### Return Value
-`PKG` object
-
-#### Body Logic
-The function iterates over the array of file metadata, parses each file using `parseFile`, and collects the parsed facts in an array. It then builds a call graph using the `buildCallGraph` function and assembles the PKG using the `buildPKG` function.
-
-## Dependencies
-
-* `path`
-* `fs`
-* `../utils/logger`
-* `./ast/laravel/index`
-* `./call-graph`
-* `./pkg-builder`
-
-## Usage Example
-```javascript
-const files = [...]; // array of file metadata
-const meta = {...}; // project metadata
-const config = {...}; // configuration object
-
-const pkg = await parseFiles(files, meta, config);
-```

package/legacyver-docs/src/parser/pattern-detector.md

@@ -1,28 +0,0 @@
-## Overview
-This module provides a domain pattern detector that scans function body text for known patterns. It exports two functions: `detectPatterns` and `PATTERNS`.
-
-## Functions
-### detectPatterns
-#### Description
-Scans the provided `bodyText` for known patterns and returns an array of matching pattern names.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| bodyText | string | The text to scan for patterns |
-
-#### Return Value
-An array of pattern names that match the provided `bodyText`
-
-### PATTERNS
-#### Description
-An array of objects containing pattern definitions.
-
-## Dependencies
-* None
-
-## Usage Example
-```javascript
-const patterns = detectPatterns('/* */');
-console.log(patterns); // Output: ['arithmetic']
-```

package/legacyver-docs/src/parser/pkg-builder.md

@@ -1,34 +0,0 @@
-## Overview
-The `buildPKG` function assembles all FileFacts into a Project Knowledge Graph (PKG) based on the provided `allFacts` and `meta` objects.
-
-## Functions
-### buildPKG
-#### Description
-Assemble all FileFacts into a Project Knowledge Graph (PKG).
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| allFacts | Array | An array of FileFacts objects. |
-| meta | Object | An object containing metadata about the project. |
-
-#### Return Value
-An object containing the following properties:
-* `meta`: An object containing the original `meta` object with an additional `totalFiles` property set to the length of `allFacts`.
-* `files`: An object where each key is a file path and the value is the corresponding FileFacts object.
-* `entryPoints`: An array of file paths that are not called by any other file.
-* `graph`: An object where each key is a file path and the value is an array of files that the file calls.
-* `laravelMeta`: An object containing aggregated metadata for Laravel projects, including route maps, relationships, provider bindings, and model names.
-
-## Dependencies
-* `module.exports`
-
-## Usage Example
-The `buildPKG` function can be used to assemble a Project Knowledge Graph from an array of FileFacts objects and a metadata object. For example:
-```javascript
-const allFacts = [...]; // array of FileFacts objects
-const meta = { ... }; // metadata object
-const pkg = buildPKG(allFacts, meta);
-console.log(pkg);
-```
-Note that this example assumes that the `buildPKG` function is exported as a module and can be imported and used in a separate script.

package/legacyver-docs/src/renderer/html.md

@@ -1,36 +0,0 @@
-## Overview
-The `render` function generates a single self-contained HTML file with lunr.js search functionality for documentation fragments.
-
-## Functions
-### render
-* Description: Generates a single HTML file with lunr.js search functionality for documentation fragments.
-* Parameters:
-	+ `fragments`: An array of documentation fragments.
-	+ `pkg`: The package metadata.
-	+ `outputDir`: The directory to output the HTML file.
-	+ `config`: The configuration object (not used in the code).
-* Return Value: None (writes the HTML file to disk)
-* Calls:
-	+ `mkdirSync`
-	+ `map`
-	+ `replace`
-	+ `join`
-	+ `marked`
-	+ `stringify`
-	+ `lunr`
-	+ `field`
-	+ `forEach`
-	+ `add`
-	+ `getElementById`
-	+ `addEventListener`
-	+ `trim`
-	+ `search`
-	+ `writeFileSync`
-
-## Dependencies
-* `fs`: `writeFileSync`, `mkdirSync`
-* `path`: `path`
-* `marked`: `marked`
-
-## Usage Example
-The `render` function can be used to generate a single HTML file with lunr.js search functionality for documentation fragments. The function takes an array of fragments, package metadata, output directory, and configuration object as input. It generates the HTML file and writes it to the output directory. The HTML file includes a search bar and displays the documentation fragments in a list. When a search query is entered, the function uses lunr.js to search the documentation fragments and displays the results.

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

@@ -1,26 +0,0 @@
-## Overview
-The `render` function is a renderer dispatcher that takes in fragments, a package object, an output directory, and a configuration object, and renders the fragments in the specified format.
-
-## Functions
-### render
-| Parameter | Type | Description |
-| --- | --- | --- |
-| fragments |  | The fragments to be rendered |
-| pkg |  | The package object |
-| outputDir |  | The directory where the rendered output will be written |
-| config |  | The configuration object |
-
-Returns: `Promise<void>`
-
-## Dependencies
-* `fs: mkdirSync`
-* `../utils/errors: RenderError`
-
-## Usage Example
-Based on the code, it appears that the `render` function can be used to render fragments in different formats (HTML, JSON, or Markdown) by passing the desired format in the `config.format` property. For example:
-```javascript
-const render = require('./renderer');
-const config = { format: 'html' };
-render(fragments, pkg, outputDir, config);
-```
-Note: The usage example is based on the detected pattern in the code, where the `config.format` property is used to determine the rendering format.

package/legacyver-docs/src/renderer/json.md

@@ -1,25 +0,0 @@
-## Overview
-The `render` function is a JSON renderer that enriches the `pkg` object with LLM (Large Language Model) descriptions from the provided `fragments`. It writes the enriched `pkg` object to a JSON file in the specified `outputDir`.
-
-## Functions
-### render
-#### Description
-Enriches the `pkg` object with LLM descriptions from the provided `fragments` and writes the enriched object to a JSON file.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fragments | array | An array of objects containing LLM descriptions |
-| pkg | object | The package object to be enriched |
-| outputDir | string | The directory where the enriched JSON file will be written |
-| config | object | (not used in the code) |
-
-#### Return Value
-None
-
-## Dependencies
-* `fs: writeFileSync, mkdirSync`
-* `path: path`
-
-## Usage Example
-Since the code does not provide a clear usage example, there is no example to document.

package/legacyver-docs/src/renderer/markdown.md

@@ -1,77 +0,0 @@
-## Overview
-This module exports a single function, `render`, which generates Markdown files for a project's documentation. It takes four parameters: `fragments`, `pkg`, `outputDir`, and `config`.
-
-## Functions
-
-### render
-#### Description
-Generates Markdown files for a project's documentation.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| fragments | array | An array of objects containing file metadata. |
-| pkg | object | An object containing project metadata. |
-| outputDir | string | The directory where the generated Markdown files will be written. |
-| config | object | An object containing configuration settings (not used in this function). |
-
-#### Return Value
-None (async)
-
-#### Detected Patterns
-* Arithmetic operations
-
-#### Body
-The function creates a directory for the output files, then iterates over the `fragments` array. For each fragment, it creates a Markdown file with the fragment's content and adds a line to the `summaryLines` array. Finally, it writes the `summaryLines` array to a file named `SUMMARY.md` and writes the result of calling `buildIndexMd` to a file named `index.md`.
-
-### buildIndexMd
-#### Description
-Generates the content of the `index.md` file.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| pkg | object | An object containing project metadata. |
-| fragments | array | An array of objects containing file metadata. |
-
-#### Return Value
-A string containing the Markdown content of the `index.md` file.
-
-#### Detected Patterns
-* Arithmetic operations
-
-#### Body
-The function creates an array of lines to be written to the `index.md` file. It adds lines for the project's metadata, a file tree, a Mermaid dependency graph, and Laravel-specific sections (if present). The function returns the joined lines as a string.
-
-### sanitizeMermaid
-#### Description
-Sanitizes a string for use in a Mermaid graph.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| str | string | The string to be sanitized. |
-
-#### Return Value
-The sanitized string.
-
-#### Detected Patterns
-* Arithmetic operations
-
-#### Body
-The function replaces non-alphanumeric characters with underscores, removes leading underscores, and truncates the string to 40 characters. If the string is empty, it returns the string "node".
-
-## Dependencies
-* `fs`: `writeFileSync`, `mkdirSync`, `existsSync`
-* `path`: `path`
-
-## Usage Example
-```javascript
-const render = require('./markdown');
-const fragments = [...]; // array of file metadata objects
-const pkg = {...}; // project metadata object
-const outputDir = './docs';
-render(fragments, pkg, outputDir).then(() => {
-  console.log('Documentation generated successfully!');
-});
-```

package/legacyver-docs/src/utils/config.md

@@ -1,62 +0,0 @@
-## Overview
-This module provides utility functions for managing session data and configuration in a CLI application.
-
-## Functions
-
-### loadSession()
-Loads the session data from the session file.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| None |  |  |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| Object |  | The loaded session data, or an empty object if the file is missing or malformed. |
-
-### saveSession(data)
-Saves the session data to the session file.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| data | Object | The session data to save. |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| None |  |  |
-
-### clearSession()
-Deletes the session file.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| None |  |  |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| None |  |  |
-
-### loadConfig(cliFlags)
-Loads the configuration from a file and merges it with CLI flags.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| cliFlags | Object | The CLI flags to merge with the configuration. |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| Object |  | The merged configuration. |
-
-## Dependencies
-
-* cosmiconfig: for loading configuration from files
-* fs: for file system operations
-* path: for working with file paths
-* os: for accessing the user's home directory
-
-## Usage Example
-```javascript
-const config = loadConfig({ provider: 'groq' });
-console.log(config);
-```
-Note: This example assumes that the `loadConfig` function is exported and can be imported in another module. The actual usage will depend on how this module is used in the application.

package/legacyver-docs/src/utils/errors.md

@@ -1,53 +0,0 @@
-## Overview
-This module exports custom error classes for Legacyver, providing a structured way to handle and report errors.
-
-## Functions
-### LegacyverError
-* Description: Base class for all Legacyver errors.
-* Parameters:
-	| Name | Type | Description |
-	| --- | --- | --- |
-	| message | string | The error message. |
-	| code | string | The error code (optional, defaults to 'LEGACYVER_ERROR'). |
-* Return Value: An instance of LegacyverError.
-
-### NoApiKeyError
-* Description: Error thrown when no API key is found for a provider.
-* Parameters:
-	| Name | Type | Description |
-	| --- | --- | --- |
-	| provider | string | The provider for which no API key was found. |
-* Return Value: An instance of NoApiKeyError.
-
-### RateLimitError
-* Description: Error thrown when the rate limit is exceeded for a provider.
-* Parameters:
-	| Name | Type | Description |
-	| --- | --- | --- |
-	| provider | string | The provider for which the rate limit was exceeded. |
-	| retryAfter | number | The number of milliseconds to wait before retrying (optional, defaults to 1000). |
-* Return Value: An instance of RateLimitError.
-
-### ParseError
-* Description: Error thrown when a file fails to parse.
-* Parameters:
-	| Name | Type | Description |
-	| --- | --- | --- |
-	| filePath | string | The path to the file that failed to parse. |
-	| originalError | Error | The original error that occurred during parsing (optional). |
-* Return Value: An instance of ParseError.
-
-### RenderError
-* Description: Error thrown when a renderer fails.
-* Parameters:
-	| Name | Type | Description |
-	| --- | --- | --- |
-	| format | string | The format for which the renderer failed. |
-	| originalError | Error | The original error that occurred during rendering (optional). |
-* Return Value: An instance of RenderError.
-
-## Dependencies
-* `Error` (built-in JavaScript class)
-
-## Usage Example
-No clear pattern is visible in the code, so no usage example is provided.

package/legacyver-docs/src/utils/logger.md

@@ -1,48 +0,0 @@
-## Overview
-This module provides a logging utility with customizable log levels and colorized output. It allows users to set the log level and determine whether the log should be displayed based on the current log level.
-
-## Functions
-
-### setLevel(level)
-Sets the current log level.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| level | string | The new log level (one of 'debug', 'info', 'warn', 'error') |
-
-### setCI(val)
-Sets whether the log is being run in a Continuous Integration environment.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| val | boolean | Whether the log is being run in a CI environment |
-
-### shouldLog(level)
-Determines whether a log with the given level should be displayed based on the current log level.
-
-| Param | Type | Description |
-| --- | --- | --- |
-| level | string | The log level to check (one of 'debug', 'info', 'warn', 'error') |
-
-### debug(...args)
-Logs a message at the debug level.
-
-### info(...args)
-Logs a message at the info level.
-
-### warn(...args)
-Logs a message at the warn level.
-
-### error(...args)
-Logs a message at the error level.
-
-## Dependencies
-* `picocolors` (as `pc`)
-
-## Usage Example
-Based on the code, it appears that the `debug` function can be used to log a message at the debug level, like this:
-```javascript
-const logger = require('./logger');
-logger.debug('This is a debug message');
-```
-Note that this is just an example based on the code, and the actual usage may vary depending on the context in which this module is used.