feat: updated utils for better reporting/reusability

Author: dastrong-codiga

src/checkPush.js

@@ -1,7 +1,7 @@
 import {
   executeGitCommand,
   findClosestSha,
-  getRootDirectory,
+  getGitDirectoryRequired,
 } from "../utils/git";
 import {
   getRulesetsFromCodigaFile,
@@ -100,7 +100,7 @@ export async function checkPush(remoteShaArg, localShaArg) {
   }
 
   // ensure that there's a git directory to continue
-  getRootDirectory();
+  getGitDirectoryRequired();
 
   // check and verify the SHA args
   const { remoteSha, localSha } = checkSHAs(remoteShaArg, localShaArg);

utils/file.js

@@ -5,16 +5,37 @@ import { ROSIE_SUPPORTED_SUFFIX_TO_LANGUAGE } from "./constants";
 import { printEmptyLine, printFailure, printSuggestion } from "./print";
 
 /**
- * read a file contents
+ * Used to read a file
+ * If the file doesn't exist, we'll return null
  * @param {string} path
  * @returns
  */
 export function readFile(path) {
+  try {
+    return fs.readFileSync(path, "utf8");
+  } catch (err) {
+    return null;
+  }
+}
+
+/**
+ * Used to read a file
+ * If the file doesn't exist, we'll exit
+ * @param {string} path
+ * @returns
+ */
+export function readFileRequired(path) {
   try {
     const file = fs.readFileSync(path, "utf8");
     return file;
   } catch (err) {
+    printEmptyLine();
     printFailure(`Unable to read file: ${path}`);
+    printSuggestion(
+      " ↳ Please try again and contact us, if the issue persists:",
+      "https://app.codiga.io/support"
+    );
+    printEmptyLine();
     process.exit(1);
   }
 }

utils/git.js

@@ -1,5 +1,5 @@
 import child_process from "child_process";
-import { printFailure } from "./print";
+import { printEmptyLine, printFailure, printSuggestion } from "./print";
 import { isTestMode } from "../tests/test-utils";
 
 /**
@@ -20,9 +20,9 @@ export function executeGitCommand(args) {
 
 /**
  * Gets the git directory
- * @returns the directory string or exits if there isn't one
+ * @returns the directory location or null if there isn't one
  */
-export function getRootDirectory() {
+export function getGitDirectory() {
   // if we're in test mode we'll skip this check
   if (isTestMode) return "./tests/fixtures";
 
@@ -31,9 +31,28 @@ export function getRootDirectory() {
   if (rootDirectory) {
     return rootDirectory.split("\n").join("");
   } else {
+    return null;
+  }
+}
+
+/**
+ * Gets the git directory
+ * @returns the directory location or exits if there isn't one
+ */
+export function getGitDirectoryRequired() {
+  // if we're in test mode we'll skip this check
+  if (isTestMode) return "./tests/fixtures";
+
+  // now look for a git repository
+  const rootDirectory = executeGitCommand(["rev-parse", "--show-toplevel"]);
+  if (rootDirectory) {
+    return rootDirectory.split("\n").join("");
+  } else {
+    printEmptyLine();
     printFailure(
       "Unable to execute a git command because you're not in a git repository"
     );
+    printEmptyLine();
     process.exit(1);
   }
 }
@@ -98,8 +117,9 @@ export function findClosestSha() {
 
   if (output) {
     closestSha = output.replace(/\n/g, "").trim();
-    console.debug(
-      `Closest SHA found between ${currentBranch} and ${mainBranch}: ${closestSha}`
+    printSuggestion(
+      `Closest SHA found between ${currentBranch} and ${mainBranch}`,
+      closestSha
     );
   }
 

utils/rosie.js

@@ -1,7 +1,7 @@
 import { Listr } from "listr2";
 import { encodeToBase64 } from "../utils/encoding";
 import { rosieApiFetch } from "./api";
-import { getLanguageForFile, readFile } from "./file";
+import { getLanguageForFile, readFileRequired } from "./file";
 import { getRulesForRosiePerLanguage } from "./rules";
 import { printEmptyLine, printFailure, printInfo, printSubItem } from "./print";
 
@@ -62,7 +62,7 @@ export async function analyzeFiles(paths, rules) {
 
     detectedLanguages.forEach((language) => {
       files[language].forEach((file) => {
-        const fileContent = readFile(file);
+        const fileContent = readFileRequired(file);
         const body = {
           filename: file,
           language: language.toLowerCase(),

utils/rulesets.js

@@ -1,7 +1,7 @@
-import { readFile, parseYamlFile } from "../utils/file";
+import { readFileRequired, parseYamlFile } from "../utils/file";
 import { codigaApiFetch } from "./api";
 import { ACTION_TOKEN_ADD, CODIGA_CONFIG_FILE } from "./constants";
-import { getRootDirectory } from "./git";
+import { getGitDirectoryRequired } from "./git";
 import { GET_RULESETS_FOR_CLIENT } from "../graphql/queries";
 import { printCommandSuggestion, printFailure, printSuggestion } from "./print";
 import { getToken } from "./store";
@@ -35,10 +35,10 @@ export async function getRulesetsWithRules(names) {
  * @returns
  */
 export function getRulesetsFromCodigaFile() {
-  const rootDir = getRootDirectory();
+  const rootDir = getGitDirectoryRequired();
 
   const codigaFileLocation = `${rootDir}/${CODIGA_CONFIG_FILE}`;
-  const file = readFile(codigaFileLocation);
+  const file = readFileRequired(codigaFileLocation);
   const parsedFile = parseYamlFile(file, codigaFileLocation);
 
   // if there isn't a rulesets value in the codiga.yml file, throw an error