@bigbinary/neeto-audit-frontend 1.0.7 → 1.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bigbinary/neeto-audit-frontend",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Audits neeto frontend codebase for issues and suggests a fix.",
   "type": "module",
   "bin": "./dist/index.js",

package/src/cli.js

@@ -1,3 +1,5 @@
+import chalk from "chalk";
+
 import { getCliOptions, runVerifiers } from "./utils";
 import verifiers from "./verifiers";
 
@@ -7,4 +9,6 @@ const run = async () => {
   runVerifiers({ verifiers, autoFix, debug });
 };
 
-run();
+process.env.SKIP_AUDIT === "true"
+  ? console.log(chalk.green("Skipped frontend audit"))
+  : run();

package/src/constants/index.js

@@ -1,3 +1,17 @@
 import path from "path";
 
 export const PACKAGE_JSON_PATH = path.resolve("./package.json");
+
+export const STATUSES = {
+  PASS: "PASS",
+  FAIL: "FAIL",
+  SKIPPED: "SKIPPED",
+};
+
+export const NANO_TYPE_MAP = {
+  nano: "nano",
+  frontend: "frontend",
+  extension: "extension",
+  editor: "frontend",
+  molecules: "frontend",
+};

package/src/utils/index.js

@@ -10,7 +10,7 @@ import { identity, last, split } from "ramda";
 import { simpleGit } from "simple-git";
 import util from "util";
 
-import { PACKAGE_JSON_PATH } from "../constants";
+import { NANO_TYPE_MAP, PACKAGE_JSON_PATH } from "../constants";
 
 const run = util.promisify(exec);
 
@@ -36,10 +36,10 @@ const renderErrors = (errors = [], isAutoFixFlagPresent = false) => {
 const getResults = async ({ verifiers, debug }) => {
   let errors = [];
   const results = verifiers.map(async ([name, verifier]) => {
-    const { isSuccess = false, error } = await verifier(debug);
+    const { isSuccess = false, error, status } = await verifier(debug);
     !isSuccess && errors.push(error);
 
-    return { name, isSuccess };
+    return { name, isSuccess, status };
   });
 
   const allResults = await Promise.all(results);
@@ -219,10 +219,10 @@ export const runVerifiers = async ({ verifiers, autoFix, debug }) => {
   const { results, errors } = await getResults({ verifiers, autoFix, debug });
   const isErrorPresent = isNotEmpty(errors);
 
-  results.map(({ name, isSuccess }) => {
+  results.map(({ name, isSuccess, status }) => {
     const resultText = isSuccess
-      ? chalk.bgGreen.black("PASS")
-      : chalk.bgRed.black("FAIL");
+      ? chalk.bgGreen.black(status)
+      : chalk.bgRed.black(status);
     console.log(resultText, name);
   });
 
@@ -256,7 +256,10 @@ export const getNanoType = async () => {
 
   const projectName = projectGitName.split(".git").at(0);
 
-  return last(split("-", projectName));
+  return {
+    type: NANO_TYPE_MAP[last(split("-", projectName))],
+    repoName: projectName,
+  };
 };
 
 export const getPackageJson = async (debug) => {

package/src/verifiers/currentNodeVersion/index.js

@@ -1,6 +1,7 @@
 import { NVMRC_FILE_PATH, REQUIRED_NODE_VERSION } from "./constants";
 import { createOrReplaceFile, getFileContent } from "../../utils";
 import { getSemVer } from "./utils";
+import { STATUSES } from "../../constants";
 
 const currentNodeVersion = async (debug) => {
   const fix = async (debug) => {
@@ -28,10 +29,14 @@ const currentNodeVersion = async (debug) => {
     patch >= REQUIRED_NODE_VERSION.patch;
 
   if (!isSuccess) {
-    return { error: "There is a mismatch in the node version.", fix };
+    return {
+      error: "There is a mismatch in the node version.",
+      status: STATUSES.FAIL,
+      fix,
+    };
   }
 
-  return { isSuccess };
+  return { isSuccess, status: STATUSES.PASS };
 };
 
 export default currentNodeVersion;

package/src/verifiers/eslint/index.js

@@ -7,13 +7,18 @@ import {
   identicalDirectoryFiles,
 } from "../../utils";
 import { ESLINT_DESTINATION_DIRECTORY, NANOS_TO_OVERRIDE } from "./constants";
+import { STATUSES } from "../../constants";
 
 const eslint = async (debug) => {
-  const nanoType = await getNanoType();
+  const { type, repoName } = await getNanoType();
 
-  const eslintCommonSource = NANOS_TO_OVERRIDE.includes(nanoType)
-    ? nanoType
-    : "common";
+  // neeto-molecules has different ESLint rules disabled. This does not match other frontend packages.
+  // So, decided to skip this check instead of adding a different config check just for a single repo.
+  if (repoName === "neeto-molecules") {
+    return { isSuccess: true, status: STATUSES.SKIPPED };
+  }
+
+  const eslintCommonSource = NANOS_TO_OVERRIDE.includes(type) ? type : "common";
 
   const eslintSourceDirectory = path.resolve(
     `./node_modules/@bigbinary/neeto-audit-frontend/common/eslint/${eslintCommonSource}`
@@ -38,10 +43,14 @@ const eslint = async (debug) => {
   const isSuccess = eslintFiles.every(identity);
 
   if (!isSuccess) {
-    return { error: "ESLint and its related files are not present.", fix };
+    return {
+      error: "ESLint and its related files are not present.",
+      status: STATUSES.FAIL,
+      fix,
+    };
   }
 
-  return { isSuccess };
+  return { isSuccess, status: STATUSES.PASS };
 };
 
 export default eslint;

package/src/verifiers/husky/index.js

@@ -12,11 +12,12 @@ import {
   HUSKY_SOURCE_DIRECTORY,
   HUSKY_COMMON_SOURCE_DIRECTORY,
 } from "./constants";
+import { STATUSES } from "../../constants";
 
 const husky = async (debug) => {
-  const nanoType = await getNanoType();
+  const { type } = await getNanoType();
 
-  const nanoSourceDirectory = `${HUSKY_SOURCE_DIRECTORY}/${nanoType}`;
+  const nanoSourceDirectory = `${HUSKY_SOURCE_DIRECTORY}/${type}`;
 
   const fix = async (debug) => {
     await createOrReplaceDirectoryFiles({
@@ -60,10 +61,14 @@ const husky = async (debug) => {
   const isSuccess = huskyFiles.every(identity);
 
   if (!isSuccess) {
-    return { error: "Some husky helper files are not present.", fix };
+    return {
+      error: "Some husky helper files are not present.",
+      status: STATUSES.FAIL,
+      fix,
+    };
   }
 
-  return { isSuccess };
+  return { isSuccess, status: STATUSES.PASS };
 };
 
 export default husky;

package/src/verifiers/prettier/index.js

@@ -7,11 +7,18 @@ import {
   identicalDirectoryFiles,
 } from "../../utils";
 import { PRETTIER_DESTINATION_PATH } from "./constants";
+import { STATUSES } from "../../constants";
 
 const prettier = async (debug) => {
-  const nanoType = await getNanoType();
+  const { type, repoName } = await getNanoType();
 
-  const prettierCommonSource = nanoType === "extension" ? nanoType : "common";
+  // neeto-molecules uses custom tailwind plugins for styles. This does not match other frontend packages.
+  // So, decided to skip this check instead of adding a different config check just for a single repo.
+  if (repoName === "neeto-molecules") {
+    return { isSuccess: true, status: STATUSES.SKIPPED };
+  }
+
+  const prettierCommonSource = type === "extension" ? type : "common";
 
   const prettierSourceDirectory = path.resolve(
     `./node_modules/@bigbinary/neeto-audit-frontend/common/prettier/${prettierCommonSource}`
@@ -38,11 +45,12 @@ const prettier = async (debug) => {
   if (!isSuccess) {
     return {
       error: "There are some discrepancy in the prettier configurations.",
+      status: STATUSES.FAIL,
       fix,
     };
   }
 
-  return { isSuccess };
+  return { isSuccess, status: STATUSES.PASS };
 };
 
 export default prettier;

package/src/verifiers/recommendedPackageVersions/index.js

@@ -2,7 +2,7 @@ import { existsBy, isNotEmpty } from "@bigbinary/neeto-commons-frontend/pure";
 import { mergeDeepRight, objOf } from "ramda";
 
 import recommendedDependencies from "../../../common/recommendedDependencies";
-import { PACKAGE_JSON_PATH } from "../../constants";
+import { PACKAGE_JSON_PATH, STATUSES } from "../../constants";
 import {
   createOrReplaceFile,
   execute,
@@ -18,11 +18,11 @@ import {
 const recommendedPackageVersions = async (debug) => {
   const packageJson = await getPackageJson(debug);
 
-  const nanoType = await getNanoType();
+  const { type } = await getNanoType();
 
   const recommendedVersions = mergeDeepRight(
     recommendedDependencies["common"],
-    recommendedDependencies[nanoType]
+    recommendedDependencies[type]
   );
 
   const packagesToUpdate = getOutdatedPackages(
@@ -62,11 +62,12 @@ const recommendedPackageVersions = async (debug) => {
   if (!isSuccess) {
     return {
       error: "The dependency packages are not using the recommended versions.",
+      status: STATUSES.FAIL,
       fix,
     };
   }
 
-  return { isSuccess };
+  return { isSuccess, status: STATUSES.PASS };
 };
 
 export default recommendedPackageVersions;