@empiricalrun/test-gen 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @empiricalrun/test-gen
 
+## 0.1.3
+
+### Patch Changes
+
+- b32c561: fix: increase readability of logs
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/bin/index.js

@@ -13,9 +13,11 @@ const prettier_1 = __importDefault(require("prettier"));
 const eslint_1 = require("eslint");
 const dotenv_1 = __importDefault(require("dotenv"));
 const yaml_1 = require("yaml");
+const logger_1 = require("./logger");
 dotenv_1.default.config({
     path: [".env.local", ".env"],
 });
+const logger = new logger_1.CustomLogger();
 async function readFilesInDirectory(dir = "") {
     let files = [];
     const items = await fs_extra_1.default.readdir(dir);
@@ -67,7 +69,6 @@ async function getLLMResult(instruction) {
         ],
         model: "gpt-4o",
     });
-    console.log("generated completion");
     const response = completion.choices[0]?.message.content || "";
     return response;
 }
@@ -83,32 +84,24 @@ function validateTypescript(filePath) {
     const errors = [];
     const syntacticDiagnostics = program.getSyntacticDiagnostics(sourceFile);
     if (syntacticDiagnostics.length > 0) {
-        console.log("Syntactic errors:");
         syntacticDiagnostics.forEach((diagnostic) => {
             const { line, character } = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start);
             const message = typescript_1.default.flattenDiagnosticMessageText(diagnostic.messageText, "\n");
-            console.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
+            logger.log(`${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`);
             if (typeof diagnostic.messageText === "string") {
                 errors.push(diagnostic.messageText);
             }
         });
     }
-    else {
-        console.log("No syntactic errors.");
-    }
     // Get and report any semantic errors
     const semanticDiagnostics = program.getSemanticDiagnostics(sourceFile);
     if (semanticDiagnostics.length > 0) {
-        console.log("Semantic errors:");
         semanticDiagnostics.forEach((diagnostic) => {
-            console.log(diagnostic.messageText);
-            if (typeof diagnostic.messageText == "string") {
-                errors.push(diagnostic.messageText);
-            }
+            errors.push(diagnostic.messageText.toString());
         });
     }
-    else {
-        console.log("No semantic errors.");
+    if (!errors.length) {
+        logger.success("Found no type issues!");
     }
     return errors;
 }
@@ -120,7 +113,7 @@ async function formatCode(filePath) {
         filepath: filePath,
     });
     fs_extra_1.default.writeFileSync(filePath, formattedContent);
-    console.log("File formatted successfully.");
+    logger.success("File formatted successfully!");
 }
 async function stripAndPrependImports(content) {
     const imports = content.match(/import.* from.*;/g);
@@ -141,12 +134,12 @@ async function generateTest(scenarios, file) {
     const pomPrompt = await generatePromptFromDirectory("./pages");
     const testFileContent = fs_extra_1.default.readFileSync(file, "utf-8");
     for (const i in scenarios) {
+        console.log("\n\n");
         const scenario = scenarios[i];
-        console.log("Generating test for scenario: ", scenario?.name);
+        logger.log("Generating test for scenario:", scenario?.name);
         //TODO: improve this logic. its buggy
         if (testFileContent.includes(`test("${scenario?.name}"`)) {
-            console.log("test already exists for this scenario", scenario?.name);
-            console.log("skipping test generation");
+            logger.success("Test already exists for this scenario");
             continue;
         }
         const instruction = `
@@ -183,25 +176,27 @@ async function generateTest(scenarios, file) {
         - Donot repeat steps which are already mentioned in the "test.beforeEach" block
         - Add import statements at the beginning of the output.
         `;
-        console.log("constructed instruction for llm");
         let response = await getLLMResult(instruction);
+        logger.success("Test generated successfully!");
         const contents = fs_extra_1.default.readFileSync(file, "utf-8");
         const [prependContent, strippedContent] = await stripAndPrependImports(response);
         await fs_extra_1.default.writeFile(file, prependContent + contents + `\n\n${strippedContent}`, "utf-8");
-        console.log("Linting generated output");
+        logger.log("Linting generated code...");
         await lintErrors(file);
-        console.log("Validating types");
+        logger.log("Validating types...");
         let errors = validateTypescript(file);
         const maxIteration = 2;
         let counter = 0;
         while (errors.length > 0) {
-            console.log(errors);
             const fileContent = fs_extra_1.default.readFileSync(file, "utf-8");
             counter += 1;
             if (counter > maxIteration) {
-                console.log(`Max iteration limit reached. Please review the file ${file} and manually fix the typescript errors.`);
+                logger.error(`Unable to fix typescript errors. Please review ${file} manually and fix the typescript errors. Run the test-gen command again, once errors are fixed`);
                 break;
             }
+            logger.warn("Found few errors while validating types:");
+            errors.forEach(e => logger.warn(e));
+            logger.log("Trying to fix above errors...");
             const instruction = `
         You are a software engineer who is given a task to create test basis a scenario provided to you.
         You will be provided with current tests, fixtures and page object models for you to use and write test.
@@ -230,18 +225,16 @@ async function generateTest(scenarios, file) {
         - Donot modify anything else apart from the code required to fix typescript error
         `;
             response = await getLLMResult(instruction);
-            console.log("fixed");
-            console.log(response);
-            errors = validateTypescript(file);
             await fs_extra_1.default.writeFile(file, response, "utf-8");
+            await lintErrors(file);
+            errors = validateTypescript(file);
         }
-        console.log("formatting spec file");
         await formatCode(file);
     }
 }
 (async function main() {
     if (process.argv.length != 3) {
-        console.log("Provide a path to scenarios path to generate test");
+        logger.error("Please provide path to scenarios using command:", "npx @empiricalrun/test-gen <SCENARIOS_FILE_PATH>");
         process.exit(1);
     }
     else {
@@ -252,11 +245,8 @@ async function generateTest(scenarios, file) {
         const scenarios = config.scenarios;
         const fileDir = config.dir || "./tests";
         const filePath = `${fileDir}/${fileName}.spec.ts`;
-        if (fs_extra_1.default.existsSync(filePath)) {
-            console.log("Spec file already exists, skipping generation");
-        }
-        else {
-            console.log("Spec file does not exist, creating new spec file");
+        if (!fs_extra_1.default.existsSync(filePath)) {
+            logger.log(`Creating a new spec file: ${filePath}`);
             fs_extra_1.default.createFileSync(filePath);
         }
         await generateTest(scenarios, filePath);

package/dist/bin/logger/index.d.ts

@@ -0,0 +1,13 @@
+export interface Logger {
+    log: (message?: string, ...optionalParams: any[]) => void;
+    warn: (message?: string, ...optionalParams: any[]) => void;
+    error: (message?: string, ...optionalParams: any[]) => void;
+    success: (message?: string, ...optionalParams: any[]) => void;
+}
+export declare class CustomLogger implements Logger {
+    log(message?: string, ...optionalParams: any[]): void;
+    warn(message?: string, ...optionalParams: any[]): void;
+    success(message?: string, ...optionalParams: any[]): void;
+    error(message?: string, ...optionalParams: any[]): void;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/bin/logger/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/bin/logger/index.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC1D,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC3D,KAAK,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IAC5D,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;CAC/D;AAED,qBAAa,YAAa,YAAW,MAAM;IACzC,GAAG,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAI9C,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAI/C,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;IAIlD,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,cAAc,EAAE,GAAG,EAAE;CAGjD"}

package/dist/bin/logger/index.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomLogger = void 0;
+const picocolors_1 = require("picocolors");
+class CustomLogger {
+    log(message, ...optionalParams) {
+        console.log("🪵 ", (0, picocolors_1.cyan)(message), ...optionalParams);
+    }
+    warn(message, ...optionalParams) {
+        console.log("🟡 ", (0, picocolors_1.yellow)(message), ...optionalParams);
+    }
+    success(message, ...optionalParams) {
+        console.log("✅", (0, picocolors_1.green)(message), ...optionalParams);
+    }
+    error(message, ...optionalParams) {
+        console.log("🚨", (0, picocolors_1.red)(message), ...optionalParams);
+    }
+}
+exports.CustomLogger = CustomLogger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/test-gen",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -19,6 +19,7 @@
     "eslint": "^8.57.0",
     "fs-extra": "^11.2.0",
     "openai": "^4.47.2",
+    "picocolors": "^1.0.1",
     "prettier": "^3.2.5",
     "typescript": "^5.3.3",
     "yaml": "^2.4.2"