legacyver 3.1.0 → 3.4.0

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

@@ -1,59 +0,0 @@
-## Overview
-The `parse` function is a parser for Go source code, responsible for extracting and analyzing the structure of the code.
-
-## Functions
-### parse
-#### Description
-Parses Go source code and extracts functions, classes, imports, and exports.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| `sourceText` | string | The source code to parse. |
-| `relativePath` | string | The relative path of the source code. |
-
-#### Return Value
-An object containing the parsed data, including functions, classes, imports, exports, and other metadata.
-
-### findBlockEnd
-#### Description
-Finds the end of a block in the source code, starting from a given index.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| `lines` | array | The source code split into lines. |
-| `startIdx` | number | The starting index to search from. |
-
-#### Return Value
-The index of the end of the block, or the length of the `lines` array if no block is found.
-
-### extractCalls
-#### Description
-Extracts function calls from a given source code snippet.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| `body` | string | The source code snippet to extract calls from. |
-
-#### Return Value
-An array of function call names.
-
-## Dependencies
-* `../complexity-scorer: scoreComplexity`
-* `../body-extractor: extractBodySnippet`
-
-## Usage Example
-```javascript
-const sourceText = `
-func main() {
-  fmt.Println("Hello, World!")
-}
-`;
-
-const relativePath = './main.go';
-const parsedData = parse(sourceText, relativePath);
-console.log(parsedData);
-```
-Note: This example is not directly visible in the code, but it can be inferred from the `parse` function's usage.

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

@@ -1,58 +0,0 @@
-## Overview
-The `parse` function is a parser for Java source code, responsible for extracting and analyzing the structure of a Java file. It takes two parameters: `sourceText` and `relativePath`, and returns an object containing information about the file's structure, including functions, classes, imports, and exports.
-
-## Functions
-### parse
-| Parameter | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code of the Java file to parse |
-| relativePath | string | The relative path of the Java file |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| object |  | An object containing information about the file's structure |
-
-The `parse` function iterates over each line of the source code, using regular expressions to identify imports, classes, and methods. It extracts information about each method, including its name, parameters, return type, and body.
-
-### findBlockEnd
-| Parameter | Type | Description |
-| --- | --- | --- |
-| lines | array | The array of lines to search for the block end |
-| startIdx | number | The starting index to search from |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| number |  | The index of the line where the block ends |
-
-The `findBlockEnd` function finds the index of the line where a block ends by counting the number of opening and closing curly brackets.
-
-### extractCalls
-| Parameter | Type | Description |
-| --- | --- | --- |
-| body | string | The body of a method or function |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| array |  | An array of function or method names called in the body |
-
-The `extractCalls` function uses a regular expression to find all function or method calls in the body of a method or function, and returns an array of the names of these calls.
-
-## Dependencies
-* `../complexity-scorer: scoreComplexity`
-* `../body-extractor: extractBodySnippet`
-
-## Usage Example
-```javascript
-const sourceText = `
-public class MyClass {
-  public void myMethod() {
-    System.out.println("Hello, World!");
-  }
-}
-`;
-
-const relativePath = 'path/to/MyClass.java';
-const result = parse(sourceText, relativePath);
-console.log(result);
-```
-This example shows how to use the `parse` function to parse a Java file and extract its structure. The `relativePath` parameter is used to specify the relative path of the file, and the `sourceText` parameter is the source code of the file. The `result` object contains information about the file's structure, including the functions, classes, imports, and exports.

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

@@ -1,71 +0,0 @@
-## Overview
-This is a JavaScript AST parser that uses regex and heuristics to parse JavaScript code. It is designed to be a robust implementation, as it is not using the web-tree-sitter WASM parser.
-
-## Functions
-
-### parse
-#### Description
-Parses a JavaScript source code string and extracts information about functions, classes, imports, and exports.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code to parse. |
-| relativePath | string | The relative path of the source code. |
-
-#### Return Value
-An object containing the parsed information.
-
-### parseParams
-#### Description
-Parses a string of comma-separated parameter names and returns an array of objects with the parameter name and type.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| paramsStr | string | The string of comma-separated parameter names. |
-
-#### Return Value
-An array of objects with the parameter name and type.
-
-### findBlockEnd
-#### Description
-Finds the end of a block in a given array of lines.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| lines | array | The array of lines to search. |
-| startIdx | number | The starting index to search from. |
-
-#### Return Value
-The index of the end of the block.
-
-### extractCalls
-#### Description
-Extracts a list of function calls from a given string.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| body | string | The string to extract calls from. |
-
-#### Return Value
-An array of function calls.
-
-## Dependencies
-* `../complexity-scorer: scoreComplexity`
-* `../body-extractor: extractBodySnippet`
-* `y: x`
-
-## Usage Example
-```javascript
-const sourceText = `
-function foo() {
-  console.log('Hello World!');
-}
-`;
-const relativePath = './path/to/file.js';
-const parsed = parse(sourceText, relativePath);
-console.log(parsed);
-```

package/legacyver-docs/src/parser/ast/laravel/blade.md

@@ -1,45 +0,0 @@
-## Overview
-The `extract` function is used to extract Blade template facts from a given source text.
-
-## Functions
-### extract
-#### Description
-Extracts Blade template facts from a source text.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to extract facts from. |
-| relativePath | string | The relative path of the source text. |
-
-#### Return Value
-An object containing various metadata about the source text, including:
-* `relativePath`: The relative path of the source text.
-* `language`: The language of the source text, which is always 'php'.
-* `fileType`: The file type of the source text, which is always 'blade'.
-* `linesOfCode`: The number of lines of code in the source text.
-* `functions`: An empty array, as this function does not extract function information.
-* `classes`: An empty array, as this function does not extract class information.
-* `imports`: An empty array, as this function does not extract import information.
-* `exports`: An array containing the `extract` function itself.
-* `callsTo`: An empty array, as this function does not call any other functions.
-* `calledBy`: An empty array, as this function is not called by any other functions.
-* `hash`: Null, as this function does not generate a hash.
-* `parserType`: The type of parser used, which is always 'blade'.
-* `laravelContext`: An object containing various metadata about the source text in the context of Laravel, including:
-	+ `type`: The type of the source text, which is always 'blade'.
-	+ `directives`: An array of directives found in the source text.
-	+ `includedViews`: An array of included views found in the source text.
-	+ `outputExpressions`: An array of output expressions found in the source text.
-
-## Dependencies
-* `module.exports`
-
-## Usage Example
-The `extract` function can be used as follows:
-```javascript
-const sourceText = '... Blade template code ...';
-const relativePath = 'path/to/template.blade.php';
-const extractedFacts = extract(sourceText, relativePath);
-console.log(extractedFacts);
-```

package/legacyver-docs/src/parser/ast/laravel/classifier.md

@@ -1,29 +0,0 @@
-## Overview
-This module exports a function `classify` that takes a relative file path and the source text of a Laravel PHP file, and returns its role in the application.
-
-## Functions
-### classify
-Classify a Laravel PHP file into its role.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| relativePath | string | The relative path to the file. |
-| sourceText | string | The source text of the file. |
-
-Returns:
-| Type | Description |
-| --- | --- |
-| string | The role of the file, one of: 'controller', 'model', 'middleware', 'provider', 'route_file', 'blade', 'request', or 'other'. |
-
-## Dependencies
-* `path`: The Node.js `path` module.
-
-## Usage Example
-The following example demonstrates how to use the `classify` function:
-```javascript
-const classifier = require('./classifier');
-const relativePath = 'app/Http/Controllers/UserController.php';
-const sourceText = '...'; // source text of the file
-const role = classifier.classify(relativePath, sourceText);
-console.log(role); // Output: 'controller'
-```

package/legacyver-docs/src/parser/ast/laravel/controller.md

@@ -1,57 +0,0 @@
-## Overview
-The `extract` function is used to extract Laravel Controller specifics from a given `sourceText` and `fileFacts`. It returns an object containing information about the controller's type, route actions, injected services, and form requests.
-
-## Functions
-### extract
-| Parameter | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code of the file to extract information from. |
-| fileFacts | object | An object containing information about the file, including its functions. |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| laravelContext | object | An object containing information about the Laravel Controller, including its type, route actions, injected services, and form requests. |
-
-## Dependencies
-* `match`
-* `split`
-* `trim`
-* `push`
-* `methods`
-* `test`
-
-## Usage Example
-The function can be used to extract information from a Laravel Controller file, for example:
-```javascript
-const sourceText = `
-public function __construct($service1, $service2) {}
-public function index(Request $request) {}
-public function store(Request $request) {}
-`;
-
-const fileFacts = {
-  functions: [
-    {
-      name: 'index',
-      params: [{ type: 'Request' }],
-      isExported: true
-    },
-    {
-      name: 'store',
-      params: [{ type: 'Request' }],
-      isExported: true
-    }
-  ]
-};
-
-const laravelContext = extract(sourceText, fileFacts);
-console.log(laravelContext);
-// Output:
-// {
-//   type: 'controller',
-//   routeActions: ['index', 'store'],
-//   injectedServices: [{ type: 'service1', name: '$service1' }, { type: 'service2', name: '$service2' }],
-//   formRequests: [{ method: 'index', requestClass: 'Request' }, { method: 'store', requestClass: 'Request' }]
-// }
-```
-Note: The usage example is based on the patterns detected in the code and may not cover all possible scenarios.

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

@@ -1,27 +0,0 @@
-## Overview
-The `enrich` function enriches a FileFacts object with Laravel-specific context.
-
-## Functions
-### enrich
-#### Description
-Enrich a FileFacts object with Laravel-specific context.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code of the file. |
-| fileFacts | Object | The base FileFacts object from the PHP parser. |
-
-#### Return Value
-An enriched FileFacts object with Laravel-specific context.
-
-## Dependencies
-* `./classifier: classify`
-* `./controller: extract: extractController`
-* `./model: extract: extractModel`
-* `./routes: extract: extractRoutes`
-* `./blade: extract: extractBlade`
-* `./provider: extract: extractProvider`
-
-## Usage Example
-No clear pattern is visible in the code.

package/legacyver-docs/src/parser/ast/laravel/model.md

@@ -1,34 +0,0 @@
-## Overview
-The `extract` function is used to extract Laravel Model specifics from a given source text and FileFacts.
-
-## Functions
-### extract
-#### Description
-Extracts Laravel Model specifics from a given source text and FileFacts.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to extract from. |
-| fileFacts | object | An object containing information about the file, including its functions. |
-
-#### Return Value
-An object containing the extracted Laravel Model specifics, including the table name, fillable fields, guarded fields, and relationships.
-
-## Dependencies
-* `match`
-* `split`
-* `map`
-* `trim`
-* `replace`
-* `filter`
-* `RegExp`
-* `join`
-* `slice`
-* `max`
-* `exec`
-* `pop`
-* `push`
-
-## Usage Example
-Based on the code, it appears that the `extract` function is designed to be used in a loop, where it iterates over the functions in the `fileFacts` object and extracts the relevant information from the `sourceText`. However, without a clear pattern or example usage, it's difficult to provide a concrete usage example.

package/legacyver-docs/src/parser/ast/laravel/provider.md

@@ -1,31 +0,0 @@
-## Overview
-The `extract` function is used to extract Service Provider specifics from a given source text and file facts.
-
-## Functions
-### extract
-#### Description
-Extracts Service Provider specifics from a given source text and file facts.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to extract from. |
-| fileFacts | object | An object containing file facts. |
-
-#### Return Value
-An object containing the extracted Service Provider specifics.
-
-#### Body Logic
-The function iterates through the `register()` and `boot()` method bodies in the file facts to extract relevant information. For the `register()` method, it uses a regular expression to find bindings and adds them to the `registerBindings` array. For the `boot()` method, it simply adds a string indicating the presence of the `boot()` method to the `bootActions` array.
-
-## Dependencies
-* `find` function from `fileFacts.functions`
-* `exec` function from regular expression
-* `push` function from `laravelContext.registerBindings` and `laravelContext.bootActions`
-
-## Usage Example
-The code does not provide a clear usage example, but the function can be used as follows:
-```javascript
-const laravelContext = extract(sourceText, fileFacts);
-console.log(laravelContext);
-```

package/legacyver-docs/src/parser/ast/laravel/routes.md

@@ -1,31 +0,0 @@
-## Overview
-This module exports a function `extract` that parses Laravel route files and extracts route definitions.
-
-## Functions
-### extract
-Extracts route definitions from a given source text.
-
-| Parameter | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to extract route definitions from |
-
-| Return Value | Type | Description |
-| --- | --- | --- |
-| object | { type: 'route_file', routes } | An object containing the extracted route definitions |
-
-## Dependencies
-* `module.exports`
-
-## Usage Example
-```javascript
-const routes = extract('Route::get('users', [UserController::class, 'index'])->middleware('auth')->name('users.index');');
-console.log(routes);
-```
-This example extracts a single route definition from the given source text and logs the result to the console. The extracted route definition is an object with the following properties:
-
-* `method`: The HTTP method of the route (e.g. "get")
-* `uri`: The URI of the route (e.g. "users")
-* `controller`: The controller class of the route (e.g. "UserController")
-* `action`: The action method of the route (e.g. "index")
-* `middleware`: The middleware applied to the route (e.g. "auth")
-* `name`: The name of the route (e.g. "users.index")

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

@@ -1,127 +0,0 @@
-## Overview
-This is a PHP Abstract Syntax Tree (AST) parser that takes source code as input and returns an object containing the parsed data.
-
-## Functions
-### parse
-#### Description
-Parses the source code and returns an object containing the parsed data.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code to parse. |
-| relativePath | string | The relative path of the source code. |
-
-#### Return Value
-An object containing the parsed data.
-
-#### Calls
-| Function | Description |
-| --- | --- |
-| parsePhpParams | Parses PHP function parameters. |
-| findBlockEnd | Finds the end of a block in the source code. |
-| extractCalls | Extracts function calls from the source code. |
-| scoreComplexity | Scores the complexity of the source code. |
-| extractBodySnippet | Extracts a snippet of the source code. |
-
-### publicFns
-#### Description
-Returns an array of public function names.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| functions | array | The array of functions to filter. |
-
-#### Return Value
-An array of public function names.
-
-#### Calls
-| Function | Description |
-| --- | --- |
-| filter | Filters the array of functions. |
-| map | Maps the array of functions to an array of function names. |
-
-### parsePhpParams
-#### Description
-Parses PHP function parameters.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| paramsStr | string | The string of parameters to parse. |
-
-#### Return Value
-An array of parsed parameters.
-
-#### Calls
-| Function | Description |
-| --- | --- |
-| trim | Trims the string of parameters. |
-| split | Splits the string of parameters into an array. |
-| map | Maps the array of parameters to an array of parsed parameters. |
-| match | Matches the string of parameters against a regular expression. |
-| filter | Filters the array of parsed parameters. |
-
-### findBlockEnd
-#### Description
-Finds the end of a block in the source code.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| lines | array | The array of lines in the source code. |
-| startIdx | number | The index of the start of the block. |
-
-#### Return Value
-The index of the end of the block.
-
-#### Calls
-| Function | Description |
-| --- | --- |
-| findBlockEnd | Recursively finds the end of the block. |
-
-### extractCalls
-#### Description
-Extracts function calls from the source code.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| body | string | The body of the function to extract calls from. |
-
-#### Return Value
-An array of extracted function calls.
-
-#### Calls
-| Function | Description |
-| --- | --- |
-| matchAll | Matches the body of the function against a regular expression. |
-| Set | Creates a set of unique function calls. |
-| has | Checks if a function call is in the set. |
-| add | Adds a function call to the set. |
-| filter | Filters the array of function calls. |
-
-## Dependencies
-* `../complexity-scorer: scoreComplexity`
-* `../body-extractor: extractBodySnippet`
-
-## Usage Example
-```javascript
-const sourceCode = `
-namespace App\\Http\\Controllers;
-
-use Illuminate\\Support\\Facades\\Auth;
-
-class UserController extends Controller
-{
-    public function index()
-    {
-        // ...
-    }
-}
-`;
-
-const parsedData = parse(sourceCode, 'path/to/source/code');
-console.log(parsedData);
-```

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

@@ -1,62 +0,0 @@
-## Overview
-The `parse` function is a parser for Python source code, responsible for extracting and analyzing the structure of a Python file. It takes two parameters: `sourceText` and `relativePath`, and returns an object containing information about the file's structure, including functions, classes, imports, and exports.
-
-## Functions
-
-### parse
-#### Description
-Parses a Python source code file and extracts its structure.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source code of the Python file. |
-| relativePath | string | The relative path of the Python file. |
-
-#### Return Value
-An object containing information about the file's structure, including functions, classes, imports, and exports.
-
-### findBlockEnd
-#### Description
-Finds the end of a block in a list of lines.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| lines | array | The list of lines to search. |
-| startIdx | number | The index to start searching from. |
-
-#### Return Value
-The index of the end of the block.
-
-### extractCalls
-#### Description
-Extracts function calls from a string.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| body | string | The string to extract calls from. |
-
-#### Return Value
-An array of function calls.
-
-## Dependencies
-* `../complexity-scorer: scoreComplexity`
-* `../body-extractor: extractBodySnippet`
-
-## Usage Example
-```javascript
-const sourceText = `
-def add(a, b):
-  return a + b
-
-def multiply(a, b):
-  return a * b
-`;
-
-const relativePath = 'example.py';
-const result = parse(sourceText, relativePath);
-console.log(result);
-```
-Note: The usage example is not directly visible in the code, but it can be inferred from the function signature and the structure of the `parse` function.

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

@@ -1,22 +0,0 @@
-## Overview
-This module provides a TypeScript parser that extends the JavaScript parser, handling type annotations.
-
-## Functions
-### parse
-#### Description
-Parses a TypeScript source text and returns the parsed result with the language set to 'typescript'.
-
-#### Parameters
-| Name | Type | Description |
-| --- | --- | --- |
-| sourceText | string | The source text to parse. |
-| relativePath | string | The relative path of the source file. |
-
-#### Return Value
-The parsed result with the language set to 'typescript'.
-
-## Dependencies
-* `./javascript: parse: parseJS` - The JavaScript parser function.
-
-## Usage Example
-None. The code does not provide a clear usage example.