catchall: update comments and rename function meaningfully

ashwiniraokarai · May 10, 2024 · a0fecb2 · a0fecb2
1 parent 6f89912
commit a0fecb2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/playwright.config.ts b/playwright.config.ts
@@ -20,7 +20,7 @@ dotenv.config({
   path: DOT_ENV_FILE_PATH,
 });
 
-//Show the environment you're running tests o
+//Show the environment you're running tests on
 console.log("Loaded env config file: " + DOT_ENV_FILE_PATH +
             "\nRunning on environment: " + DOT_ENV_FILE_NAME +
             "\nAt: " + process.env.URL

diff --git a/tests/test-data/JSONFileParser.ts b/tests/test-data/JSONFileParser.ts
@@ -1,5 +1,8 @@
 import fs from "fs";
 
+/*Leverage fs object to read contents of JSON file, then parse it to regular JS object
+ This process is an overkill for this use-case because the test has to convert the JS object back to JSON
+*/
 function extractArticlesTestDataFrom(testDataJSONFilePath): Object {
     const testDataJSONString = fs.readFileSync(testDataJSONFilePath, "utf8");
     return JSON.parse(testDataJSONString);

diff --git a/tests/test-data/articles-with-randomized-data.ts b/tests/test-data/articles-with-randomized-data.ts
@@ -5,7 +5,7 @@ This function returns a JS/TS Object (It's not JSON. Clue: The Keys aren't Strin
 The resulting JS object is intended to be converted to JSON by the caller before use
 */
 
-function fakerGeneratedArticlesData(): Object{
+function generateArticlesDataFromFaker(): Object{
     return {
         articles:[
             {
@@ -66,4 +66,4 @@ function fakerGeneratedArticlesData(): Object{
  Exporting as a "default" on the other hand, allows me to wrap up the function as an object
  Plus, the importer does not have to worry about the specifics to import. And can look up callable elements using the default exported object
 */
-export default {fakerGeneratedArticlesData};
+export default {generateArticlesDataFromFaker};