Dir-Walk

Dir-Walk (dir_walk.sh) is a bash script to recursively walk a directory tree and do something useful within each directory.

One such example is the generation of an M3U file for any directory that contains OGG audio files (see the script itself for details). This script however, as written, just outputs the full path of the current directory from the directory root passed in.

Developed with a Bash Template (BaT)

Dir-Walk uses a Bash shell template (BaT) called A-Bash-Template designed to make script development and command line argument management more robust, easier to implement, and easier to maintain. Here are a few of those features:

• Dependencies checker: a routine that checks all external program dependencies (e.g., jq)
• Arguments and script details--such as script description and syntax--are stored in the JSON file format (i.e., config.json)
• JSON queries (using jq) handled through wrapper functions
• A script banner function automates banner generation, reading directly from config.json
• Command line arguments are parsed and tested for completeness using both short and long-format argument syntax (e.g., -f|--font)
• Optional command line arguments are permissible and managed through the JSON configuration file
• Template functions organized into libraries (see the Bash-Lib project for details) to minimize code footprint in the main script

For more details about using a bash template, check out the BaT sources here.

Requirements

• An operational Bash environment (Bash 5.1.8 used during development)
• One additional external program:
  • jq, for parsing the config.json file

While this package was initially written and tested under Linux (Ubuntu 21.10), there should be no reason why this won't work under other shells or Unix-like operating systems that support the gsettings application.

Basic Usage

Dir-Walk is run through a command line interface, so all of the command options are made available there.

Here's the default response when running dir_walk.sh with no arguments:

$ ./dir_walk.sh

 |
 |  Dir Walk: recurse into directory(s) and do something interesting
 |    1.0.0
 |
 |  Usage:
 |    dir_walk.sh -d directory
 |
 |  -d, --directory  directory root to recurse into
 |

Error: directory argument (-d|--directory) missing.

In this example, the program responds by indicating that the required script arguments must be set before proper operation.

When arguments are correctly passed, the script provides feedback on the success or failure of the script actions:

$ ./dir_walk.sh -d ~/music

 |
 |  Dir Walk: recurse into directory(s) and do something interesting
 |    1.0.0
 |
 |  Usage:
 |    dir_walk.sh -d directory
 |
 |  -d, --directory  directory root to recurse into
 |

/home/user/music/A Flock of Seagulls
/home/user/music/A Flock of Seagulls/A Flock of Seagulls
/home/user/music/Alanis Morissette
/home/user/music/Alanis Morissette/Jagged Little Pill
/home/user/music/Alanis Morissette/Supposed Former Infatuation Junkie
/home/user/music/Alan Parsons
/home/user/music/Alan Parsons/Try Anything Once

IMPORTANT: This Project Uses Git Submodules

This project uses Git submodule project(s) (located in the bash-lib folder) to keep this project up-to-date without manual intervention.

Be sure to clone this project with the --recursive switch (git clone --recursive https://github.com/richbl/this_project) so any submodule project(s) will be automatically cloned as well. If you clone into this project without this switch, you'll likely see empty submodule project folders (depending on your version of Git).