Add configuration option to skip search paths

CHANGELOG.md

@@ -8,6 +8,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- `[skip_paths]` config section: name directories that Asimov should never search, alongside the built-in `~/.Trash` and `~/Library`. Thanks [@lunaluxie](https://github.com/lunaluxie)!
+
 - `asimov doctor` now checks the data files and reports how many sentinels and fixed directories are loaded, so an incomplete install is diagnosed rather than just failing.
 
 ### Changed

README.md

@@ -131,7 +131,7 @@ If `mdfind` doesn't list your projects, the run isn't reaching them. The two usu
 ## Usage
 
 ```
-asimov [--dry-run] [--verbose] [--quiet] [--stats] [--no-read-cache] [--no-write-cache] [--help] [--version]
+asimov [--dry-run] [--verbose] [--quiet] [--stats] [--no-read-cache] [--no-write-cache] [--help] [--version] [directory]
 asimov prune  [--quiet]
 asimov doctor [--quiet]
 ```
@@ -274,6 +274,20 @@ extra   = ~/my-build-cache       # plus any paths you name (always excluded when
 extra   = ~/golang/pkg/mod       # e.g. a Go module cache under a custom GOPATH
 ```
 
+### Skip parts of your home directory
+
+Asimov never descends into `~/.Trash` or `~/Library`. Add directories of your own under `[skip_paths]` and they're left alone too - not searched, never excluded:
+
+```ini
+[skip_paths]
+extra = ~/Music                  # one "extra =" line per directory
+extra = ~/Pictures
+```
+
+This only narrows the *search*. Global caches you opted into under `[fixed_dirs]` are still excluded, even inside a skipped path.
+
+If all your code lives in one folder, scanning just that folder (`asimov ~/Code`, see [usage](#usage)) is usually simpler than skipping everything else.
+
 ## Other install methods
 
 **From source:**

lib/asimov/config.sh

@@ -14,6 +14,7 @@ load_config() {
     ASIMOV_CONFIG_EXTRA_SENTINELS=()
     ASIMOV_CONFIG_DISABLED_SENTINELS=()
     ASIMOV_CONFIG_SCAN_DIRS=()
+    ASIMOV_CONFIG_EXTRA_SKIP_PATHS=()
 
     [[ -f "$ASIMOV_CONFIG_FILE" ]] || return 0
 
@@ -52,6 +53,10 @@ load_config() {
                 sentinels:disabled)
                     ASIMOV_CONFIG_DISABLED_SENTINELS+=("$value")
                     ;;
+                skip_paths:extra)
+                    value="${value/#\~/$HOME}"
+                    ASIMOV_CONFIG_EXTRA_SKIP_PATHS+=("$value")
+                    ;;
             esac
         fi
     done < "$ASIMOV_CONFIG_FILE"

lib/asimov/data.sh

@@ -64,7 +64,9 @@ load_fixed_dirs() {
     done < "$file"
 }
 
-# Load data/skip-paths.tsv into ASIMOV_SKIP_PATHS (absolute).
+# Load data/skip-paths.tsv into ASIMOV_SKIP_PATHS (absolute), then append the
+# paths named under [skip_paths] in the config. Both the find expression and the
+# Spotlight top-up read this one array, so they cannot drift apart.
 load_skip_paths() {
     local file="${ASIMOV_DATA}/skip-paths.tsv"
     require_data_file "$file"
@@ -74,6 +76,10 @@ load_skip_paths() {
         [[ -z "$path" || "$path" == '#'* ]] && continue
         ASIMOV_SKIP_PATHS+=("${ASIMOV_ROOT}/${path}")
     done < "$file"
+
+    for path in ${ASIMOV_CONFIG_EXTRA_SKIP_PATHS[@]+"${ASIMOV_CONFIG_EXTRA_SKIP_PATHS[@]}"}; do
+        ASIMOV_SKIP_PATHS+=("$path")
+    done
 }
 
 # Every sentinel record in effect for this run, one "dir sentinel" pair per line:

lib/asimov/doctor.sh

@@ -271,7 +271,7 @@ doctor_check_config() {
         if [[ "$line" =~ ^\[([a-z_]+)\]$ ]]; then
             section="${BASH_REMATCH[1]}"
             case "$section" in
-                fixed_dirs|scan|sentinels) ;;
+                fixed_dirs|scan|sentinels|skip_paths) ;;
                 *)
                     unknown=$((unknown + 1))
                     doctor_problem "unknown section [${section}] in ${ASIMOV_CONFIG_FILE}"
@@ -284,11 +284,11 @@ doctor_check_config() {
             key="${BASH_REMATCH[1]}"
             case "${section}:${key}" in
                 fixed_dirs:enabled|fixed_dirs:extra|scan:extra|\
-                sentinels:extra|sentinels:disabled) ;;
+                sentinels:extra|sentinels:disabled|skip_paths:extra) ;;
                 *)
                     # A key under an already-reported section is the same fault.
                     case "$section" in
-                        fixed_dirs|scan|sentinels)
+                        fixed_dirs|scan|sentinels|skip_paths)
                             unknown=$((unknown + 1))
                             doctor_problem "unknown key '${key}' under [${section}] in ${ASIMOV_CONFIG_FILE}"
                             ;;

tests/behavior.bats

@@ -120,6 +120,46 @@ load test_helper
   [[ "$(count_exclusions)" -eq 0 ]]
 }
 
+@test "skips directories given in [skip_paths] config" {
+  write_config "[skip_paths]
+extra = ~/Music"
+  create_project "Music/Code/First-Project" "composer.json" "vendor"
+  run_asimov
+  refute_excluded "${HOME}/Music/Code/First-Project/vendor"
+  [[ "$(count_exclusions)" -eq 0 ]]
+}
+
+@test "excludes the same project when [skip_paths] is absent" {
+  create_project "Music/Code/First-Project" "composer.json" "vendor"
+  run_asimov
+  assert_excluded "${HOME}/Music/Code/First-Project/vendor"
+}
+
+@test "[skip_paths] accepts several entries" {
+  write_config "[skip_paths]
+extra = ~/Music
+extra = ~/Pictures"
+  create_project "Music/First-Project" "composer.json" "vendor"
+  create_project "Pictures/Second-Project" "package.json" "node_modules"
+  create_project "Code/Third-Project" "package.json" "node_modules"
+  run_asimov
+  refute_excluded "${HOME}/Music/First-Project/vendor"
+  refute_excluded "${HOME}/Pictures/Second-Project/node_modules"
+  assert_excluded "${HOME}/Code/Third-Project/node_modules"
+}
+
+@test "[skip_paths] does not suppress fixed directories inside it" {
+  write_config "[fixed_dirs]
+enabled = true
+extra = ~/Music/build-cache
+
+[skip_paths]
+extra = ~/Music"
+  mkdir -p "${HOME}/Music/build-cache"
+  run_asimov
+  assert_excluded "${HOME}/Music/build-cache"
+}
+
 # =============================================================================
 # Nested project handling
 # =============================================================================

tests/doctor.bats

@@ -260,6 +260,26 @@ enabled = true"
   [[ "$output" == *".config/asimov/config"* ]]
 }
 
+@test "doctor accepts a [skip_paths] section" {
+  write_config "[skip_paths]
+extra = ~/Music"
+
+  run_asimov doctor
+
+  [[ "$status" -eq 0 ]]
+  [[ "$output" == *"looks valid"* ]]
+}
+
+@test "doctor flags an unknown key under [skip_paths]" {
+  write_config "[skip_paths]
+exrta = ~/Music"
+
+  run_asimov doctor
+
+  [[ "$status" -eq 1 ]]
+  [[ "$output" == *"exrta"* ]]
+}
+
 @test "doctor flags an unknown config key" {
   write_config "[fixed_dirs]
 enbaled = true"