chore(cli): Rename fail-empty-glob -> fail-no-files

Old flag remains as `alias`, so this is not breaking
alexpovel · Aug 11, 2024 · ff615cc · ff615cc
1 parent 9673678
commit ff615cc
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -1272,8 +1272,8 @@ Options (global):
           
           Names of processed files are written to stdout.
 
-      --fail-empty-glob
-          Fail if file globbing is requested but returns no matches.
+      --fail-no-files
+          Fail if working on files (e.g. globbing is requested) but none are found.
 
   -i, --invert
           Undo the effects of passed actions, where applicable

diff --git a/benches/bench-files.sh b/benches/bench-files.sh
@@ -23,9 +23,9 @@ bench() {
 
         hyperfine \
             --warmup 1 \
-            "./srgn --gitignored --fail-empty-glob --go comments --files 'kubernetes/**/*.go' '[tT]he (\w+)'" \
-            "./srgn --gitignored --fail-empty-glob --python comments --files 'django/**/*.py' '[tT]he (\w+)'" \
-            "./srgn --gitignored --fail-empty-glob --python comments --files 'pydantic/**/*.py' '[tT]he (\w+)'"
+            "./srgn --gitignored --fail-no-files --go comments --files 'kubernetes/**/*.go' '[tT]he (\w+)'" \
+            "./srgn --gitignored --fail-no-files --python comments --files 'django/**/*.py' '[tT]he (\w+)'" \
+            "./srgn --gitignored --fail-no-files --python comments --files 'pydantic/**/*.py' '[tT]he (\w+)'"
     )
 }
 

diff --git a/src/main.rs b/src/main.rs
@@ -319,7 +319,7 @@ fn handle_actions_on_many_files_sorted(
     info!("Saw {} items", n_files_seen);
     info!("Processed {} files", n_files_processed);
 
-    if n_files_seen == 0 && args.options.fail_empty_glob {
+    if n_files_seen == 0 && args.options.fail_no_files {
         Err(ProgramError::NoFilesFound)
     } else if n_files_processed == 0 && args.options.fail_none {
         Err(ProgramError::NothingProcessed)
@@ -429,7 +429,7 @@ fn handle_actions_on_many_files_threaded(
     let n_files_processed = *n_files_processed.lock().unwrap();
     info!("Processed {} files", n_files_processed);
 
-    if n_files_seen == 0 && args.options.fail_empty_glob {
+    if n_files_seen == 0 && args.options.fail_no_files {
         Err(ProgramError::NoFilesFound)
     } else if n_files_processed == 0 && args.options.fail_none {
         Err(ProgramError::NothingProcessed)
@@ -1000,9 +1000,9 @@ mod cli {
         /// Names of processed files are written to stdout.
         #[arg(long, verbatim_doc_comment)]
         pub files: Option<glob::Pattern>,
-        /// Fail if file globbing is requested but returns no matches.
-        #[arg(long, verbatim_doc_comment)]
-        pub fail_empty_glob: bool,
+        /// Fail if working on files (e.g. globbing is requested) but none are found.
+        #[arg(long, verbatim_doc_comment, alias = "fail-empty-glob")]
+        pub fail_no_files: bool,
         /// Undo the effects of passed actions, where applicable
         ///
         /// Requires a 1:1 mapping (bijection) between replacements and original, which

diff --git a/tests/cli.rs b/tests/cli.rs
@@ -508,23 +508,23 @@ Heizoelrueckstossabdaempfung.
         None,
     )]
     #[case(
-        "fail-empty-glob-in-search-mode-sorted",
+        "fail-no-files-in-search-mode-sorted",
         None,
         &[
             "--sorted",
-            "--fail-empty-glob",
+            "--fail-no-files",
             "--python",
             "strings",
             r".",
         ],
         Some(Path::new("tests/langs/go")), // No Python files here...
     )]
     #[case(
-        "fail-empty-glob-outside-search-mode-sorted",
+        "fail-no-files-outside-search-mode-sorted",
         None,
         &[
             "--sorted",
-            "--fail-empty-glob",
+            "--fail-no-files",
             "--files",
             "**/*.there-is-no-such-suffix",
             r".",
@@ -588,21 +588,21 @@ Heizoelrueckstossabdaempfung.
         None,
     )]
     #[case(
-        "fail-empty-glob-in-search-mode-multithreaded",
+        "fail-no-files-in-search-mode-multithreaded",
         None,
         &[
-            "--fail-empty-glob",
+            "--fail-no-files",
             "--python",
             "strings",
             r".",
         ],
         Some(Path::new("tests/langs/go")), // No Python files here...
     )]
     #[case(
-        "fail-empty-glob-outside-search-mode-multithreaded",
+        "fail-no-files-outside-search-mode-multithreaded",
         None,
         &[
-            "--fail-empty-glob",
+            "--fail-no-files",
             "--files",
             "**/*.there-is-no-such-suffix",
             r".",

diff --git a/...ty-glob-in-search-mode-multithreaded.snap → ...o-files-in-search-mode-multithreaded.snap b/...ty-glob-in-search-mode-multithreaded.snap → ...o-files-in-search-mode-multithreaded.snap
@@ -6,7 +6,7 @@ info:
     - "Error: No files found"
 ---
 args:
-  - "--fail-empty-glob"
+  - "--fail-no-files"
   - "--python"
   - strings
   - "."

diff --git a/...ail-empty-glob-in-search-mode-sorted.snap → ..._fail-no-files-in-search-mode-sorted.snap b/...ail-empty-glob-in-search-mode-sorted.snap → ..._fail-no-files-in-search-mode-sorted.snap
@@ -7,7 +7,7 @@ info:
 ---
 args:
   - "--sorted"
-  - "--fail-empty-glob"
+  - "--fail-no-files"
   - "--python"
   - strings
   - "."

diff --git a/...ob-outside-search-mode-multithreaded.snap → ...es-outside-search-mode-multithreaded.snap b/...ob-outside-search-mode-multithreaded.snap → ...es-outside-search-mode-multithreaded.snap
@@ -6,7 +6,7 @@ info:
     - "Error: No files found"
 ---
 args:
-  - "--fail-empty-glob"
+  - "--fail-no-files"
   - "--files"
   - "**/*.there-is-no-such-suffix"
   - "."

diff --git a/...mpty-glob-outside-search-mode-sorted.snap → ...-no-files-outside-search-mode-sorted.snap b/...mpty-glob-outside-search-mode-sorted.snap → ...-no-files-outside-search-mode-sorted.snap
@@ -7,7 +7,7 @@ info:
 ---
 args:
   - "--sorted"
-  - "--fail-empty-glob"
+  - "--fail-no-files"
   - "--files"
   - "**/*.there-is-no-such-suffix"
   - "."