chore(cli): Rename files -> glob

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

Hide file tree

Showing 22 changed files with 38 additions and 38 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -88,7 +88,7 @@ jobs:
       - run: cargo msrv verify
 
   bench-files:
-    name: Run benchmarks for `--files` option
+    name: Run benchmarks for `--glob` option
 
     runs-on: ubuntu-latest
 

diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -22,7 +22,7 @@
             "args": [
                 "--python",
                 "comments",
-                "--files",
+                "--glob",
                 "**/strings.py"
             ],
             "cwd": "${workspaceFolder}",

diff --git a/README.md b/README.md
@@ -1076,15 +1076,15 @@ with your own queries:
 
 #### Run against multiple files
 
-Use the `--files` option to run against multiple files, in-place. This option accepts a
+Use the `--glob` option to run against multiple files, in-place. This option accepts a
 [glob pattern](https://docs.rs/glob/0.3.1/glob/struct.Pattern.html). The glob is
 processed *within `srgn`*: it must be quoted to prevent premature shell interpretation.
-The `--files` option takes precedence over the heuristics of language scoping. For
+The `--glob` option takes precedence over the heuristics of language scoping. For
 example,
 
 <!-- markdownlint-disable MD010 -->
 ```console
-$ srgn --go 'comments' --files 'tests/langs/go/fizz*.go' '\w+'
+$ srgn --go 'comments' --glob 'tests/langs/go/fizz*.go' '\w+'
 tests/langs/go/fizzbuzz.go
 5:// fizzBuzz prints the numbers from 1 to a specified limit.
 6:// For multiples of 3, it prints "Fizz" instead of the number,
@@ -1262,7 +1262,7 @@ Standalone Actions (only usable alone):
           [aliases: squeeze-repeats]
 
 Options (global):
-      --files <FILES>
+      --glob <GLOB>
           Glob of files to work on (instead of reading stdin).
           
           If processing occurs, it is done in-place, overwriting originals.

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

diff --git a/src/main.rs b/src/main.rs
@@ -102,7 +102,7 @@ fn main() -> Result<()> {
     // See where we're reading from
     let input = match (
         args.options.stdin_override_to.unwrap_or(is_readable_stdin),
-        args.options.files.clone(),
+        args.options.glob.clone(),
         language_scoper,
     ) {
         // stdin considered viable: always use it.
@@ -998,8 +998,8 @@ mod cli {
         /// <https://docs.rs/glob/0.3.1/glob/struct.Pattern.html>
         ///
         /// Names of processed files are written to stdout.
-        #[arg(long, verbatim_doc_comment)]
-        pub files: Option<glob::Pattern>,
+        #[arg(long, verbatim_doc_comment, alias = "files")]
+        pub glob: Option<glob::Pattern>,
         /// 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,

diff --git a/tests/cli.rs b/tests/cli.rs
@@ -197,7 +197,7 @@ Heizoelrueckstossabdaempfung.
         &[
             "--python",
             "strings",
-            "--files",
+            "--glob",
             "**/*.py",
             "is",
         ],
@@ -282,7 +282,7 @@ Heizoelrueckstossabdaempfung.
         "tests/files/files-python/in",
         &[
             "--sorted",
-            "--files",
+            "--glob",
             "**/*.py",
             "foo",
             "baz"
@@ -308,7 +308,7 @@ Heizoelrueckstossabdaempfung.
             "--sorted",
             "--python",
             "function-names",
-            "--files", // Will override language scoper
+            "--glob", // Will override language scoper
             "subdir/**/*.py",
             "foo",
             "baz"
@@ -321,7 +321,7 @@ Heizoelrueckstossabdaempfung.
         &[
             "--python",
             "function-names",
-            "--files", // Will override language scoper
+            "--glob", // Will override language scoper
             "subdir/**/*.py",
             "foo",
             "baz"
@@ -477,7 +477,7 @@ Heizoelrueckstossabdaempfung.
         &[
             "--sorted",
             "--fail-none",
-            "--files",
+            "--glob",
             "**/*.py",
             "unfindable-string-dheuihiuhiulerfiuehrilufhiusdho438ryh9vuoih",
         ],
@@ -501,7 +501,7 @@ Heizoelrueckstossabdaempfung.
         &[
             "--sorted",
             "--fail-any",
-            "--files",
+            "--glob",
             "**/*.py",
             r".",
         ],
@@ -525,7 +525,7 @@ Heizoelrueckstossabdaempfung.
         &[
             "--sorted",
             "--fail-no-files",
-            "--files",
+            "--glob",
             "**/*.there-is-no-such-suffix",
             r".",
         ],
@@ -559,7 +559,7 @@ Heizoelrueckstossabdaempfung.
         None,
         &[
             "--fail-none",
-            "--files",
+            "--glob",
             "**/*.py",
             "unfindable-string-dheuihiuhiulerfiuehrilufhiusdho438ryh9vuoih",
         ],
@@ -581,7 +581,7 @@ Heizoelrueckstossabdaempfung.
         None,
         &[
             "--fail-any",
-            "--files",
+            "--glob",
             "**/*.py",
             r".",
         ],
@@ -603,7 +603,7 @@ Heizoelrueckstossabdaempfung.
         None,
         &[
             "--fail-no-files",
-            "--files",
+            "--glob",
             "**/*.there-is-no-such-suffix",
             r".",
         ],

diff --git a/tests/files/files-python/in/1-shebanged b/tests/files/files-python/in/1-shebanged
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-# Isn't touched by manual `--files` option
+# Isn't touched by manual `--glob` option
 
 # This string is not found and touched: foo
 

diff --git a/tests/files/files-python/out/1-shebanged b/tests/files/files-python/out/1-shebanged
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 
-# Isn't touched by manual `--files` option
+# Isn't touched by manual `--glob` option
 
 # This string is not found and touched: foo
 

diff --git a/tests/readme.rs b/tests/readme.rs
@@ -492,7 +492,7 @@ mod tests {
                                 tag("typescript-query"),
                                 //
                                 tag("csharp"),
-                                tag("files"),
+                                tag("glob"),
                                 tag("go"),
                                 tag("hcl"),
                                 tag("python"),

diff --git a/tests/snapshots/cli__tests__fail-any-outside-search-mode-multithreaded.snap b/tests/snapshots/cli__tests__fail-any-outside-search-mode-multithreaded.snap
@@ -7,7 +7,7 @@ info:
 ---
 args:
   - "--fail-any"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - "."
 stdin: ~

diff --git a/tests/snapshots/cli__tests__fail-any-outside-search-mode-sorted.snap b/tests/snapshots/cli__tests__fail-any-outside-search-mode-sorted.snap
@@ -8,7 +8,7 @@ info:
 args:
   - "--sorted"
   - "--fail-any"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - "."
 stdin: ~

diff --git a/tests/snapshots/cli__tests__fail-no-files-outside-search-mode-multithreaded.snap b/tests/snapshots/cli__tests__fail-no-files-outside-search-mode-multithreaded.snap
@@ -7,7 +7,7 @@ info:
 ---
 args:
   - "--fail-no-files"
-  - "--files"
+  - "--glob"
   - "**/*.there-is-no-such-suffix"
   - "."
 stdin: ~

diff --git a/tests/snapshots/cli__tests__fail-no-files-outside-search-mode-sorted.snap b/tests/snapshots/cli__tests__fail-no-files-outside-search-mode-sorted.snap
@@ -8,7 +8,7 @@ info:
 args:
   - "--sorted"
   - "--fail-no-files"
-  - "--files"
+  - "--glob"
   - "**/*.there-is-no-such-suffix"
   - "."
 stdin: ~

diff --git a/tests/snapshots/cli__tests__fail-none-explicitly-outside-search-mode-multithreaded.snap b/tests/snapshots/cli__tests__fail-none-explicitly-outside-search-mode-multithreaded.snap
@@ -7,7 +7,7 @@ info:
 ---
 args:
   - "--fail-none"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - unfindable-string-dheuihiuhiulerfiuehrilufhiusdho438ryh9vuoih
 stdin: ~

diff --git a/tests/snapshots/cli__tests__fail-none-explicitly-outside-search-mode-sorted.snap b/tests/snapshots/cli__tests__fail-none-explicitly-outside-search-mode-sorted.snap
@@ -8,7 +8,7 @@ info:
 args:
   - "--sorted"
   - "--fail-none"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - unfindable-string-dheuihiuhiulerfiuehrilufhiusdho438ryh9vuoih
 stdin: ~

diff --git a/tests/snapshots/cli__tests__files-inplace-python-linux.snap b/tests/snapshots/cli__tests__files-inplace-python-linux.snap
@@ -6,7 +6,7 @@ info:
 ---
 args:
   - "--sorted"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__files-inplace-python-macos.snap b/tests/snapshots/cli__tests__files-inplace-python-macos.snap
@@ -6,7 +6,7 @@ info:
 ---
 args:
   - "--sorted"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__files-inplace-python-windows.snap b/tests/snapshots/cli__tests__files-inplace-python-windows.snap
@@ -6,7 +6,7 @@ info:
 ---
 args:
   - "--sorted"
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-linux.snap b/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-linux.snap
@@ -8,7 +8,7 @@ args:
   - "--sorted"
   - "--python"
   - function-names
-  - "--files"
+  - "--glob"
   - subdir/**/*.py
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-macos.snap b/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-macos.snap
@@ -8,7 +8,7 @@ args:
   - "--sorted"
   - "--python"
   - function-names
-  - "--files"
+  - "--glob"
   - subdir/**/*.py
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-windows.snap b/tests/snapshots/cli__tests__language-scoping-and-files-inplace-python-windows.snap
@@ -8,7 +8,7 @@ args:
   - "--sorted"
   - "--python"
   - function-names
-  - "--files"
+  - "--glob"
   - subdir/**/*.py
   - foo
   - baz

diff --git a/tests/snapshots/cli__tests__python-search-stdin-and-files.snap b/tests/snapshots/cli__tests__python-search-stdin-and-files.snap
@@ -7,7 +7,7 @@ info:
 args:
   - "--python"
   - strings
-  - "--files"
+  - "--glob"
   - "**/*.py"
   - is
 stdin: