Add check for workspaces (#21)

Author: philippeauriach

action.yml

@@ -4,5 +4,5 @@ branding:
   icon: "chevron-right"
   color: "gray-dark"
 runs:
-  using: "node12"
+  using: "node16"
   main: "index.js"

index.js

@@ -1,5 +1,6 @@
 const checkLockVersion = require("./lib/checks/lockVersion");
 const checkForPreRelease = require("./lib/checks/preReleases");
+const checkForWorkspaces = require("./lib/checks/workspaces");
 const hasYarnLock = require("./lib/checks/yarn");
 const { FatalError } = require("./lib/errors");
 const { getPackageLock, getPackage } = require("./lib/utils");
@@ -11,6 +12,7 @@ function lint() {
   errors.push(hasYarnLock());
   errors.push(checkLockVersion(pkgLock));
   errors.push(checkForPreRelease(pkgJson));
+  errors.push(checkForWorkspaces(pkgJson));
   for (const error of errors) {
     if (error instanceof FatalError) {
       process.stderr.write(`${error.message}\n`);

lib/__tests__/workspaces.test.js

@@ -0,0 +1,21 @@
+const { FatalError } = require("../errors");
+const checkForWorkspaces = require("../checks/workspaces");
+
+describe("Check workspaces", () => {
+  it("should not return a fatal error when no workspaces are defined", () => {
+    const result = checkForWorkspaces({
+      dependencies: {
+        "@mobsuccess-devops/pre-release": "1.0.0-pr-1.0",
+      },
+    });
+    expect(result).toBeUndefined();
+  });
+  it("should not return a fatal error when workspaces are empty", () => {
+    const result = checkForWorkspaces({ workspaces: [] });
+    expect(result).toBeUndefined();
+  });
+  it("should return a fatal error when workspaces are not empty", () => {
+    const result = checkForWorkspaces({ workspaces: ["../react-ui"] });
+    expect(result).toBeInstanceOf(FatalError);
+  });
+});

lib/checks/workspaces.js

@@ -0,0 +1,10 @@
+const { FatalError } = require("../errors");
+
+function checkForWorkspaces(pkgJson = {}) {
+  const { workspaces = [] } = pkgJson;
+  if (workspaces.length > 0) {
+    return new FatalError(`Unexpected workspaces found: ${workspaces}\n`);
+  }
+}
+
+module.exports = checkForWorkspaces;