Make error codes have more meaning

Author: esotericenderman

docs/README.md

@@ -41,6 +41,17 @@ Run the script with the following command:
 - `vault`: The path to the root of your vault. This is the folder containing the `.obsidian` folder.
 - `source`: The path from a plugin directory (`.obsidian/plugins/plugin`) to its source code.
 
+## Error Codes
+
+- `1`: Failed to move to or from a directory.
+- `2`: No argument provided.
+- `3`: Directory or file does not exist.
+- `4`: Failed to read file.
+- `5`: Failed to install dependencies.
+- `6`: Failed to build.
+- `7`: Failed to install plugin.
+- `8`: Failed to clean up.
+
 ## License
 
 © 2025 [Esoteric Enderman][author-website]

src/build_obsidian_plugin.sh

@@ -1,48 +1,48 @@
-pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit
+pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit 1
 
 . ./obsidian_plugin_build_strategies.sh
 
-popd >/dev/null || exit
+popd >/dev/null || exit 1
 
 build_obsidian_plugin() {
   for plugin_source in "$@"; do
     if [[ -z "$plugin_source" ]]; then
       echo "Error: no Obsidian plugin source code provided! Can't build Obsidian plugin."
-      exit 1
+      exit 2
     fi
 
     echo "Building Obsidian plugin at path: $plugin_source"
 
     if [ ! -d "$plugin_source" ]; then
       echo "Error: Obsidian plugin source code at path $plugin_source not found!"
-      exit 2
+      exit 3
     fi
 
     pushd "$plugin_source" >/dev/null || {
       echo "Error: failed to enter Obsidian plugin source code folder at path $plugin_source!"
-      exit 3
+      exit 1
     }
 
     if [ ! -f ./manifest.json ]; then
       echo "Obsidian plugin manifest.json file not found at path $plugin_source!"
-      exit 4
+      exit 3
     fi
 
     local plugin_json
     plugin_json=$(cat ./manifest.json) || {
       echo "Error: failed to read Obsidian plugin manifest.json file at path $plugin_source!"
-      exit 5
+      exit 4
     }
 
     local plugin_id
     plugin_id=$(echo "$plugin_json" | jq -r .id) || {
       echo "Error: failed to read Obsidian plugin ID from manifest.json file when building plugin at path $plugin_source!"
-      exit 6
+      exit 4
     }
 
     if [[ -z $plugin_id ]]; then
       echo "Error: failed to read Obsidian plugin ID from manifest.json file while building Obsidian plugin at path $plugin_source!"
-      exit 6
+      exit 4
     fi
 
     echo "Building Obsidian plugin with ID $plugin_id..."
@@ -53,7 +53,7 @@ build_obsidian_plugin() {
 
     npm install || {
       echo "Error: failed to install dependencies of Obsidian plugin $plugin_id!"
-      exit 7
+      exit 5
     }
 
     local build_strategy=${obsidian_plugin_build_strategies[$plugin_id]}
@@ -70,53 +70,53 @@ build_obsidian_plugin() {
 
       pushd "./MathjaxToSVG" >/dev/null || {
         echo "Error: failed to access Obsidian $plugin_id sub-directory!"
-        exit 8
+        exit 1
       }
 
       npm install || {
         echo "Error: failed to install Obsidian plugin $plugin_id sub-directory dependencies!"
-        exit 7
+        exit 5
       }
 
       npm run build || {
         echo "Error: failed to install Obsidian plugin $plugin_id sub-project!"
-        exit 8
+        exit 6
       }
 
       popd >/dev/null || exit
 
       npm run build || {
         echo "Error: failed to build Obsidian plugin $plugin_id!"
-        exit 8
+        exit 6
       }
       ;;
     "obsidian-dev-utils")
       echo "Using Obsidian Dev Utils build strategy"
 
       npx obsidian-dev-utils build || {
         echo "Error: failed to build Obsidian plugin $plugin_id using Obsidian Dev Utils!"
-        exit 8
+        exit 6
       }
       ;;
     "yarn")
       echo "Using Yarn Obsidian plugin build strategy"
 
       npx yarn run build || {
         echo "Error: failed to build Obsidian plugin $plugin_id using Yarn!"
-        exit 8
+        exit 6
       }
       ;;
     *)
       echo "Using default Obsidian plugin build strategy"
 
       node esbuild.config.mjs production || {
         echo "Error: failed to build Obsidian plugin $plugin_id using esbuild!"
-        exit 8
+        exit 6
       }
       ;;
     esac
 
-    popd >/dev/null || exit
+    popd >/dev/null || exit 1
   done
 }
 

src/install_obsidian_plugin.sh

@@ -1,15 +1,15 @@
-pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit
+pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit 1
 
 . ./build_obsidian_plugin.sh --source-only
 
-popd >/dev/null || exit
+popd >/dev/null || exit 1
 
 install_obsidian_plugin() {
   local vault="$1"
 
   if [[ -z $vault ]]; then
     echo "Error: No Obsidian vault argument provided! Cannot install Obsidian plugin!"
-    exit 1
+    exit 2
   fi
 
   for plugin_source in "${@:2}"; do
@@ -25,24 +25,24 @@ install_obsidian_plugin() {
 
     if [ ! -d "$plugin_source" ]; then
       echo "Error: Obsidian plugin source code at path $plugin_source not found! Cannot install into vault $vault!"
-      exit 4
+      exit 3
     fi
 
     local plugin_json
     plugin_json=$(cat "./$plugin_source/manifest.json") || {
       echo "Error: failed to read Obsidian plugin manifest.json file at path $plugin_source! Cannot install into vault $vault!"
-      exit 5
+      exit 4
     }
 
     local plugin_id
     plugin_id=$(echo "$plugin_json" | jq -r .id) || {
       echo "Error: failed to read Obsidian plugin ID from manifest.json file while install plugin at path $plugin_source into Obsidian vault at path $vault!"
-      exit 6
+      exit 4
     }
 
     if [[ -z $plugin_id ]]; then
       echo "Error: failed to read Obsidian plugin ID from manifest.json file while install plugin at path $plugin_source into Obsidian vault at path $vault!"
-      exit 6
+      exit 4
     fi
 
     build_obsidian_plugin "$plugin_source"
@@ -73,36 +73,36 @@ install_obsidian_plugin() {
     "obsidian-dev-utils")
       mv "$plugin_source/dist/build/main.js" "$plugin_directory" || {
         echo "Error: failed to move main file of plugin $plugin_id built with Obsidian Dev Utils!"
-        exit 8
+        exit 7
       }
 
       mv "$plugin_source/dist/build/manifest.json" "$plugin_directory" || {
         echo "Error: failed to move manifest file of plugin $plugin_id built with Obsidian Dev Utils!"
-        exit 8
+        exit 7
       }
 
       [[ -f "$plugin_source/dist/build/styles.css" ]] && {
         mv "$plugin_source/dist/build/styles.css" "$plugin_directory" || {
           echo "Error: failed to move styles file of plugin $plugin_id built with Obsidian Dev Utils!"
-          exit 8
+          exit 7
         }
       }
       ;;
     *)
       mv "$plugin_source/main.js" "$plugin_directory" || {
         echo "Error: failed to move main file of plugin $plugin_id!"
-        exit 8
+        exit 7
       }
 
       cp "$plugin_source/manifest.json" "$plugin_directory" || {
         echo "Error: failed to move manifest file of plugin $plugin_id!"
-        exit 8
+        exit 7
       }
 
       [[ -f "$plugin_source/styles.css" ]] && {
         cp "$plugin_source/styles.css" "$plugin_directory" || {
           echo "Error: failed to move styles file of plugin $plugin_id!"
-          exit 8
+          exit 7
         }
       }
       ;;

src/install_obsidian_plugins.sh

@@ -7,24 +7,24 @@
 # vault: the path to the root of the vault (the folder that contains the .obsidian folder).
 # source: the path from a plugin folder (.obsidian/plugins/plugin) to its source code.
 
-pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit
+pushd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null || exit 1
 
 . ./install_obsidian_plugin.sh --source-only
 
-popd >/dev/null || exit
+popd >/dev/null || exit 1
 
 install_obsidian_plugins() {
     local vault="$1"
     local plugin_source_directory="$2"
 
     if [ ! -d "$vault" ]; then
         echo "Error: Obsidian vault directory $vault not found!"
-        exit 1
+        exit 3
     fi
 
     if [ ! -d "$vault/.obsidian" ]; then
         echo "Error: provided directory is not an Obsidian vault as it does not contain a .obsidian folder!"
-        exit 2
+        exit 3
     fi
 
     if ! test -d "$vault/.obsidian/plugins"; then
@@ -62,7 +62,7 @@ install_obsidian_plugins() {
 
             git submodule foreach --recursive "git restore ./ && git clean -f" || {
                 echo "Failed to restore submodules to their original state!"
-                exit 9
+                exit 8
             }
         fi
     fi