feat(cli): check if '.cache' is git ignored in compas check-env

packages/cli/src/compas/commands/check-env.js

@@ -48,6 +48,7 @@ Versions:
     await Promise.all([
       areOtherCompasVersionsInstalled(compasVersion),
       isEnvLocalNotIgnored(),
+      isDotCacheNotIgnored(),
       isDockerInstalled(),
       isGraphvizInstalled(),
     ])
@@ -94,6 +95,30 @@ async function isEnvLocalNotIgnored() {
   };
 }
 
+/**
+ * Checks if the `.cache` folder is ignored.
+ *
+ * @returns {Promise<{ failed: boolean, message?: string }>}
+ */
+async function isDotCacheNotIgnored() {
+  const { exitCode } = await exec(`git check-ignore -q .cache`);
+
+  // 128 if no git repo exists in directory
+  const result = exitCode !== 0 && exitCode !== 128;
+
+  if (!result) {
+    return {
+      failed: false,
+    };
+  }
+
+  return {
+    failed: true,
+    message:
+      "X '.cache' is not git ignored. Please add it to your '.gitignore'. This directory is used to cache results for tools like Prettier and ESLint.",
+  };
+}
+
 /**
  * Multiple versions of compas conflict with the use of ES Module live bindings, which
  * leads to weird behaviour. So warn if that is happening.