Support package.json in a monorepo setup with lockfile in parent directory

Author: paldepind

projectdo

@@ -57,6 +57,20 @@ execute_command() {
   exit 0
 }
 
+# Navigate up one directory. The command is successful if this is possible
+# without leaving the current project, entering the home directory, or entering
+# the root directory.
+go_up() {
+  if [ "$PWD" = "$PROJECT_ROOT" ]; then
+    return 1
+  fi
+  cd ..
+  if [ "$PWD" = "$HOME" ] || [ "$PWD" = / ]; then
+    return 1
+  fi
+  return 0
+}
+
 # Every supported tool requires a function `try_tool` where `tool` is a name
 # indicating what tool the function tries to detect. The function should:
 #
@@ -70,19 +84,39 @@ execute_command() {
 
 # JavaScript + NodeJS
 
+# After a `package.json` has been found this detects the tool to use based on
+# any present lock file. In monorepo setups the lockfile might be in a parent
+# directory and not right next to the `package.json` file. This is handled by
+# looking up the directory hierarchy.
+detect_nodejs_tool() {
+  while :
+  do
+    # echo looking for nodejs tool
+    if [ -f package-lock.json ]; then
+      echo yarn
+      return
+    elif [ -f bun.lock ] || [ -f bun.lockb ]; then
+      echo bun
+      return
+    elif [ -f yarn.lock ]; then
+      echo yarn
+      return
+    elif [ -f pnpm-lock.yaml ]; then
+      echo pnpm
+      return
+    fi
+    if ! go_up; then
+      echo npm
+      return
+    fi
+  done
+}
+
 try_nodejs() {
   if [ ! -f package.json ]; then
     return 1
   fi
-  if [ -f bun.lock ] || [ -f bun.lockb ]; then
-    tool=bun
-  elif [ -f yarn.lock ]; then
-    tool=yarn
-  elif [ -f pnpm-lock.yaml ]; then
-    tool=pnpm
-  else
-    tool=npm
-  fi
+  tool=$(detect_nodejs_tool)
   if ! has_command $tool; then
     echo "Found a package.json file but '$tool' is not installed."
     exit 1
@@ -507,15 +541,9 @@ set_project_root
 
 while :
 do
-  # We don't want to do anything if we are in the home or root directory
-  if [ "$PWD" = "$HOME" ] || [ "$PWD" = / ]; then
-    nothing_found
-  fi
   detect_and_run
   # If we didn't detect a tool to run in this directory we go up one directory
-  # while ensuring that we don't leave the project root
-  if [ "$PWD" = "$PROJECT_ROOT" ]; then
+  if ! go_up; then
     nothing_found
   fi
-  cd ..
 done

run-tests.sh

@@ -55,22 +55,22 @@ assertEqual() {
 RUN_EXIT=0
 
 do_build_in() {
-  RUN_RESULT=$(cd tests/"$1" && ../../projectdo -n build)
+  RUN_RESULT=$(cd tests/"$1" && "$script_directory"/projectdo -n build)
   RUN_EXIT=$?
 }
 
 do_run_in() {
-  RUN_RESULT=$(cd tests/"$1" && ../../projectdo -n run)
+  RUN_RESULT=$(cd tests/"$1" && "$script_directory"/projectdo -n run)
   RUN_EXIT=$?
 }
 
 do_test_in() {
-  RUN_RESULT=$(cd tests/"$1" && ../../projectdo -n test)
+  RUN_RESULT=$(cd tests/"$1" && "$script_directory"/projectdo -n test)
   RUN_EXIT=$?
 }
 
 do_print_tool_in() {
-  RUN_RESULT=$(cd tests/"$1" && ../../projectdo -n tool)
+  RUN_RESULT=$(cd tests/"$1" && "$script_directory"/projectdo -n tool)
   RUN_EXIT=$?
 }
 
@@ -183,6 +183,12 @@ if describe "npm / yarn / pnpm / bun"; then
     do_print_tool_in "bun"; assert
     assertEqual "$RUN_RESULT" "bun"
   fi
+  if it "detects yarn in workspace setup"; then
+    do_print_tool_in "yarn-workspace/workspace-a"; assert
+    assertEqual "$RUN_RESULT" "yarn"
+    do_print_tool_in "yarn-workspace/workspace-b"; assert
+    assertEqual "$RUN_RESULT" "yarn"
+  fi
 fi
 
 if describe "just"; then

tests/yarn-workspace/package.json

@@ -0,0 +1,4 @@
+{
+  "private": true,
+  "workspaces": ["workspace-a", "workspace-b"]
+}

tests/yarn-workspace/workspace-a/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "workspace-a",
+  "version": "1.0.0",
+  "dependencies": {}
+}

tests/yarn-workspace/workspace-b/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "workspace-b",
+  "version": "1.0.0",
+  "dependencies": {
+    "workspace-a": "1.0.0"
+  }
+}

tests/yarn-workspace/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+