@bigbinary/neeto-audit-frontend 2.0.1 → 2.0.2

package/README.md

@@ -1,3 +1,54 @@
 # neeto-audit-frontend
 
-Audits neeto frontend codebase for issues and suggests a fix.
+A package that audits neeto frontend packages for neeto-specific configuration and guidelines and suggests a fix.
+
+## Getting Started
+
+`neeto-audit-frontend` has 5 checks to ensure neeto guidelines are being followed:
+
+- Checks whether the package uses the common ESlint configuration from `neeto-commons-frontend`.
+- Checks whether the package uses the common prettier and tailwind configurations.
+- Checks whether the package uses the same set of husky pre-commit and pre-push hooks.
+- Checks whether the package uses the specified node version in `.node-version` and `.nvmrc` files.
+- Checks whether the package uses the recommended versions of common npm packages including other neeto packages.
+
+There are different types of frontend packages in neeto: nanos, widgets, extensions and frontend packages.`neeto-audit-frontend` maintains a local copy of the common configuration and a different local copy if any type of package follows a different configuration. For example, ESlint configuration is different for nanos, widgets and extensions. A local copy is maintained for each of these. The files in a package are tested against these versions to see if they match. If any check fails, it will provide the command that the user can run to fix that specific check before committing.
+
+### Installation
+
+```bash
+yarn add -D "@bigbinary/neeto-audit-frontend@latest"
+```
+
+### Run the audit
+
+```bash
+yarn neeto-audit-frontend
+```
+
+### Add CI check
+
+Add the following lines to the neetoCI YAML file.
+
+```yaml
+setup:
+  - yarn install
+jobs:
+  - name: CiChecks
+    commands:
+      - yarn neeto-audit-frontend
+```
+
+## Making changes to the configuration
+
+If any changes are made to the configuration files being checked by `neeto-audit-frontend`, the audit check will fail. If this change is necessary, we should make the same changes in the local copy maintained in `neeto-audit-frontend` to ensure the checks will pass.
+
+## Development instructions
+
+`neeto-audit-frontend` uses `pnpm` as the package manager. To setup the development environment run `pnpm install` after cloning the repository. After making changes to the verifiers, we can test the changes locally by using `yalc`. Follow the steps mentioned in [Testing frontend packages](https://neeto-engineering.neetokb.com/articles/testing-packages-locally-using-yalc) to test the changes.
+
+If, for any reason, `yarn neeto-audit-frontend` command fails after pushing the changes using `yalc`, run `yarn install --check-files`.
+
+## Building and Releasing
+
+The `@bigbinary/neeto-audit-frontend` gets published to NPM when we merge a PR with `patch`, `minor` or `major` label to the main branch. The `patch` label is used for bug fixes, `minor` label is used for new features and `major` label is used for breaking changes. You can checkout the `Create and publish releases` workflow in GitHub Actions to get a live update. Please note that before publishing the package, you need to verify the functionality in some of the neeto web-apps locally using `yalc` package manager.

package/common/.husky/widget/pre-push

@@ -0,0 +1,7 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+. "$(dirname "$0")/helpers/prevent_pushing_to_main.sh"
+. "$(dirname "$0")/helpers/neeto_audit_frontend.sh"
+
+prevent_pushing_to_main
+neeto_audit_frontend

package/common/eslint/widget/.eslintrc.js

@@ -0,0 +1,9 @@
+const defaultConfigurations = require("@bigbinary/neeto-commons-frontend/configs/nanos/eslint/index.js");
+const { mergeDeepLeft } = require("ramda");
+
+module.exports = mergeDeepLeft(
+  {
+    rules: { "@bigbinary/neeto/file-name-and-export-name-standards": "off" },
+  },
+  defaultConfigurations
+);

package/common/prettier/widget/.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  tailwindConfig: "./tailwind.config.js",
+  trailingComma: "es5",
+  arrowParens: "avoid",
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  quoteProps: "as-needed",
+  jsxSingleQuote: false,
+  singleQuote: false,
+  bracketSpacing: true,
+  bracketSameLine: false,
+  proseWrap: "always",
+  endOfLine: "lf",
+};

package/dist/index.js

@@ -18243,6 +18243,7 @@ const NANO_TYPE_MAP = {
   nano: "nano",
   frontend: "frontend",
   extension: "extension",
+  widget: "widget",
   editor: "frontend",
   molecules: "frontend",
 };
@@ -18531,7 +18532,11 @@ const currentNodeVersion = async (debug) => {
   });
 
   if (!nodeVersionFileContent) {
-    return { error: "No file or content found in the .nvmrc file.", fix };
+    return {
+      error: "No file or content found in the .nvmrc file.",
+      status: STATUSES.FAIL,
+      fix,
+    };
   }
 
   const [major = 0, minor = 0, patch = 0] = getSemVer(nodeVersionFileContent);
@@ -18554,7 +18559,7 @@ const currentNodeVersion = async (debug) => {
 
 const ESLINT_DESTINATION_DIRECTORY = path$1.resolve("./");
 
-const NANOS_TO_OVERRIDE = ["nano", "extension"];
+const NANOS_TO_OVERRIDE$1 = ["nano", "extension", "widget"];
 
 const eslint = async (debug) => {
   const { type, repoName } = await getNanoType();
@@ -18565,7 +18570,7 @@ const eslint = async (debug) => {
     return { isSuccess: true, status: STATUSES.SKIPPED };
   }
 
-  const eslintCommonSource = NANOS_TO_OVERRIDE.includes(type) ? type : "common";
+  const eslintCommonSource = NANOS_TO_OVERRIDE$1.includes(type) ? type : "common";
 
   const eslintSourceDirectory = path$1.resolve(
     `./node_modules/@bigbinary/neeto-audit-frontend/common/eslint/${eslintCommonSource}`
@@ -18671,6 +18676,8 @@ const husky = async (debug) => {
 
 const PRETTIER_DESTINATION_PATH = path$1.resolve("./");
 
+const NANOS_TO_OVERRIDE = ["extension", "widget"];
+
 const prettier = async (debug) => {
   const { type, repoName } = await getNanoType();
 
@@ -18680,7 +18687,9 @@ const prettier = async (debug) => {
     return { isSuccess: true, status: STATUSES.SKIPPED };
   }
 
-  const prettierCommonSource = type === "extension" ? type : "common";
+  const prettierCommonSource = NANOS_TO_OVERRIDE.includes(type)
+    ? type
+    : "common";
 
   const prettierSourceDirectory = path$1.resolve(
     `./node_modules/@bigbinary/neeto-audit-frontend/common/prettier/${prettierCommonSource}`
@@ -19009,6 +19018,10 @@ const recommendedPackageVersions = async (debug) => {
 
   const { type } = await getNanoType();
 
+  if (type === NANO_TYPE_MAP.widget) {
+    return { isSuccess: true, status: STATUSES.SKIPPED };
+  }
+
   const recommendedVersions = mergeDeepRight$1(
     recommendedDependencies["common"],
     recommendedDependencies[type]

package/package.json

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

package/src/constants/index.js

@@ -12,6 +12,7 @@ export const NANO_TYPE_MAP = {
   nano: "nano",
   frontend: "frontend",
   extension: "extension",
+  widget: "widget",
   editor: "frontend",
   molecules: "frontend",
 };

package/src/verifiers/currentNodeVersion/index.js

@@ -18,7 +18,11 @@ const currentNodeVersion = async (debug) => {
   });
 
   if (!nodeVersionFileContent) {
-    return { error: "No file or content found in the .nvmrc file.", fix };
+    return {
+      error: "No file or content found in the .nvmrc file.",
+      status: STATUSES.FAIL,
+      fix,
+    };
   }
 
   const [major = 0, minor = 0, patch = 0] = getSemVer(nodeVersionFileContent);

package/src/verifiers/eslint/constants.js

@@ -2,4 +2,4 @@ import path from "path";
 
 export const ESLINT_DESTINATION_DIRECTORY = path.resolve("./");
 
-export const NANOS_TO_OVERRIDE = ["nano", "extension"];
+export const NANOS_TO_OVERRIDE = ["nano", "extension", "widget"];

package/src/verifiers/prettier/constants.js

@@ -1,3 +1,5 @@
 import path from "path";
 
 export const PRETTIER_DESTINATION_PATH = path.resolve("./");
+
+export const NANOS_TO_OVERRIDE = ["extension", "widget"];

package/src/verifiers/prettier/index.js

@@ -6,7 +6,7 @@ import {
   getNanoType,
   identicalDirectoryFiles,
 } from "../../utils";
-import { PRETTIER_DESTINATION_PATH } from "./constants";
+import { PRETTIER_DESTINATION_PATH, NANOS_TO_OVERRIDE } from "./constants";
 import { STATUSES } from "../../constants";
 
 const prettier = async (debug) => {
@@ -18,7 +18,9 @@ const prettier = async (debug) => {
     return { isSuccess: true, status: STATUSES.SKIPPED };
   }
 
-  const prettierCommonSource = type === "extension" ? type : "common";
+  const prettierCommonSource = NANOS_TO_OVERRIDE.includes(type)
+    ? type
+    : "common";
 
   const prettierSourceDirectory = path.resolve(
     `./node_modules/@bigbinary/neeto-audit-frontend/common/prettier/${prettierCommonSource}`

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, STATUSES } from "../../constants";
+import { NANO_TYPE_MAP, PACKAGE_JSON_PATH, STATUSES } from "../../constants";
 import {
   createOrReplaceFile,
   execute,
@@ -20,6 +20,10 @@ const recommendedPackageVersions = async (debug) => {
 
   const { type } = await getNanoType();
 
+  if (type === NANO_TYPE_MAP.widget) {
+    return { isSuccess: true, status: STATUSES.SKIPPED };
+  }
+
   const recommendedVersions = mergeDeepRight(
     recommendedDependencies["common"],
     recommendedDependencies[type]