Merge pull request #8 from olasunkanmi-SE/javascript-parser

Javascript parser

Author: olasunkanmi-SE

.github/workflows/workflow.yml

@@ -2,7 +2,7 @@ name: CI for restaurant
 
 on:
   pull_request:
-    branches: [main]
+    branches: [main, development]
 
 jobs:
   build:
@@ -13,10 +13,11 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
-          node-version: "16"
+          node-version: "20"
       - name: ci for app
         working-directory: ./
         run: |
           npm i
           npm run build
           npm run format
+          npm run test:unit

.gitignore

@@ -1,4 +1,5 @@
 node_modules
 .env
 dist
-coverage
+coverage
+.codebuddy

README.md

@@ -1,31 +1,81 @@
 # TypeScript Code Extractor and Analyzer
 
-This project provides a robust toolkit for extracting, analyzing, and mapping TypeScript code structures.
+This project provides an advanced toolkit for parsing TypeScript code using the TypeScript Abstract Syntax Tree (AST) to extract, analyze, and map code structures.
 
-The TypeScript Code Extractor and Analyzer is a comprehensive solution designed to parse and analyze TypeScript codebases. It offers a set of tools to extract detailed information about classes, interfaces, functions, and other TypeScript constructs, enabling developers to gain deep insights into their codebase structure and dependencies.
+TypeScript Code Extractor and Analyzer is a robust system that utilizes a TypeScript parser to navigate through the codebase's AST, extracting structured metadata about various components such as modules, classes, functions, interfaces, properties, and enums.
 
-Key features include:
+Key features:
 
-- Extraction of class metadata, including methods, properties, interfaces, and enums
-- Function and method analysis, including parameter extraction and return type inference
-- Interface and enum information extraction
-- Dependency graph generation for TypeScript files
+- AST-based Class Metadata Extraction: Utilizes TypeScript's AST to gather comprehensive metadata on class methods, properties, interfaces, and enums.
+- Function and Method Signature Analysis: Parses function signatures from the AST for details on parameters, return types, and inferred type information.
+- Interface and Enum Parsing: Extracts information from AST nodes representing interfaces and enums in TypeScript.
+- Dependency Graph Construction: Builds a graph of file dependencies by analyzing import declarations within the AST.
+
+### Installation
+To integrate this tool into your project, install it via npm:
+```
+npm i @traversets/code-extractor
+```
 
 ### Code Analysis
 
-To analyze a TypeScript codebase:
+Below is an example of how to use the AST parser for code analysis:
 
 ```typescript
-import { TypeScriptCodeMapper } from "./src/services/typescript-code-mapper.service";
 
-const codeMapper = new TypeScriptCodeMapper();
+const codeMapper: TypeScriptCodeMapper = new TypeScriptCodeMapper();
 
-// Build a codebase map
-const codebaseMap = await codeMapper.buildCodebaseMap();
+// Get Root files
+const rootFiles: readonly string[] = codeMapper.getRootFileNames();
 
-// Extract class metadata
-const classInfo = codeMapper.extractClassMetaData(classNode, sourceFile);
+// Convert a rootFile into a sourceFile
+const sourceFile: ts.SourceFile = codeMapper.getSourceFile(rootFiles[5]);
 
 // Build a dependency graph
-const dependencies = codeMapper.buildDependencyGraph(sourceFile);
+const getSourceFileDepencies: string[] = codeMapper.buildDependencyGraph(sourceFile);
+
+// Build a codebase map
+const codebaseMap = await codeMapper.buildCodebaseMap().getValue();
 ```
+
+### Sample Response Structure
+The resulting JSON structure reflects the TypeScript AST's hierarchical representation:
+```
+{
+  "MyProject": {
+    "modules": {
+      "src/utils/logger.ts": {
+        "classes": [
+          {
+            "name": "Logger",
+            "functions": [
+              {
+                "name": "log",
+                "parameters": [{ "name": "message", "type": "string" }],
+                "returnType": "void",
+                "content": "",
+                "comment": "Logs application Error"
+              }
+            ],
+            "properties": [
+              { "name": "logLevel", "type": "LogLevel" }
+            ]
+          }
+        ],
+        "functions": [],
+        "interfaces": [],
+        "enums": [],
+        "dependencies": ["import { LogLevel } from './types';"]
+      }
+    }
+  }
+}
+
+```
+
+### Usage for Agentic RAG Systems
+This tool enhances Retrieval-Augmented Generation (RAG) systems by:
+
+- Parsing the TypeScript AST into embeddings for semantic code search and similarity matching
+- Leveraging AST metadata for advanced code analysis, query resolution, or to aid in code generation, thereby improving the understanding and manipulation of TypeScript codebases within AI systems.
+

package.json

@@ -16,7 +16,28 @@
     "start:dev": "concurrently \"npx tsc --watch\" \"nodemon -q dist/index.js\"",
     "format": "prettier --write \"src/**/*.ts\""
   },
-  "keywords": [],
+  "keywords": [
+    "typescript",
+    "code-extractor",
+    "rag",
+    "code-analysis",
+    "embeddings",
+    "advanced-code-analysis",
+    "code-retrieval",
+    "code-generation",
+    "codebase",
+    "code-analyzer",
+    "code-embeddings",
+    "code-toolbox",
+    "code-tool",
+    "code-extraction",
+    "code-toolkit",
+    "code-tooling",
+    "code-utility",
+    "code-utilities",
+    "code-utility-tool",
+    "code-utility-toolkit"
+  ],
   "author": "Oyinlola Olasunkanmi Raymond",
   "license": "ISC",
   "devDependencies": {

src/http/http-service.spec.ts

@@ -47,7 +47,7 @@ describe("HttpClient", () => {
           method: "GET",
           path: "/test",
         }),
-        expect.any(Function)
+        expect.any(Function),
       );
       expect(result).toEqual(mockData);
     });
@@ -69,7 +69,7 @@ describe("HttpClient", () => {
           method: "POST",
           path: "/test",
         }),
-        expect.any(Function)
+        expect.any(Function),
       );
       expect(result).toEqual(mockData);
     });
@@ -90,7 +90,7 @@ describe("HttpClient", () => {
           method: "PUT",
           path: "/test",
         }),
-        expect.any(Function)
+        expect.any(Function),
       );
       expect(result).toEqual({ statusCode: 200 });
     });
@@ -110,7 +110,7 @@ describe("HttpClient", () => {
           method: "DELETE",
           path: "/test",
         }),
-        expect.any(Function)
+        expect.any(Function),
       );
       expect(result).toEqual({ statusCode: 200 });
     });
@@ -124,7 +124,7 @@ describe("HttpClient", () => {
       });
 
       await expect(httpClient.get({}, { path: "/test" })).rejects.toThrow(
-        "Request failed with status code 500"
+        "Request failed with status code 500",
       );
     });
 
@@ -135,7 +135,7 @@ describe("HttpClient", () => {
       });
 
       await expect(httpClient.get({}, { path: "/test" })).rejects.toThrow(
-        "Failed to parse response data"
+        "Failed to parse response data",
       );
     });
   });

src/http/http-service.ts

@@ -32,7 +32,7 @@ export class HttpClient implements IHttpClient {
    **/
   async post<TRequest, TResponse>(
     payload: TRequest,
-    options?: https.RequestOptions
+    options?: https.RequestOptions,
   ): Promise<TResponse> {
     return this.sendRequest<TResponse>("POST", options, payload);
   }
@@ -44,7 +44,7 @@ export class HttpClient implements IHttpClient {
   **/
   async put<TRequest, TResponse>(
     payload: TRequest,
-    options?: https.RequestOptions
+    options?: https.RequestOptions,
   ): Promise<TResponse> {
     return this.sendRequest<TResponse>("PUT", options, payload);
   }
@@ -69,7 +69,7 @@ export class HttpClient implements IHttpClient {
     method: string,
     options?: any,
     payload?: any,
-    jwtToken?: string
+    jwtToken?: string,
   ): Promise<T> {
     const defaultHeader = this.generateRequestHeader(jwtToken);
     options.header = { ...options.header, ...defaultHeader };
@@ -102,20 +102,20 @@ export class HttpClient implements IHttpClient {
               } catch (error: any) {
                 console.log(error);
                 reject(
-                  new Error(`Failed to parse response data: ${error.message}`)
+                  new Error(`Failed to parse response data: ${error.message}`),
                 );
                 throw error;
               }
             } else {
               reject(
-                new Error(`Request failed with status code ${res.statusCode}`)
+                new Error(`Request failed with status code ${res.statusCode}`),
               );
             }
           } catch (error: any) {
             this.logger.error(
               "An error occurred during the API request.",
               JSON.stringify(error),
-              error
+              error,
             );
             throw error;
           }
@@ -125,7 +125,7 @@ export class HttpClient implements IHttpClient {
         this.logger.error(
           "An error occurred during the API request.",
           JSON.stringify(error),
-          error
+          error,
         );
         reject(error);
         throw error;
@@ -153,7 +153,7 @@ export class HttpClient implements IHttpClient {
     method: string,
     path: string,
     baseUrl: string,
-    jwtToken?: string
+    jwtToken?: string,
   ): IRequestOptions {
     const headers = this.generateRequestHeader(jwtToken);
     const options: IRequestOptions = {
@@ -178,26 +178,26 @@ export class HttpClient implements IHttpClient {
     path: string,
     baseUrl: string,
     data: any,
-    jwtToken?: string
+    jwtToken?: string,
   ): Promise<T | undefined> {
     try {
       const requestOptions: IRequestOptions = this.generateRequestOptions(
         method,
         path,
         baseUrl,
-        jwtToken
+        jwtToken,
       );
       let response: T | undefined;
       switch (method) {
         case HTTP_VERBS.GET:
           response = await this.get(
             Buffer.from(JSON.stringify({})),
-            requestOptions
+            requestOptions,
           );
         case HTTP_VERBS.POST:
           response = await this.post(
             Buffer.from(JSON.stringify(data)),
-            requestOptions
+            requestOptions,
           );
           break;
         default:
@@ -211,7 +211,7 @@ export class HttpClient implements IHttpClient {
       this.logger.error(
         "An error occurred during the API request.",
         JSON.stringify(error),
-        error
+        error,
       );
       throw error;
     }

src/interfaces/generic.interface.ts

@@ -21,6 +21,7 @@ export interface IFunctionInfo {
   returnType?: string;
   comments?: string;
   summary?: string;
+  kind?: string;
 }
 
 export interface IClassInfo {
@@ -55,6 +56,7 @@ export interface IModuleInfo {
   enums?: IEnumInfo[];
   dependencies: string[];
   properties?: IProperty[];
+  errors?: string[];
 }
 
 export interface ICodebaseMap {