feat: add --version flag for CLI

PR-URL: #308
Credit: @ajitzero
Close: #308
Reviewed-by: @isaacs

CHANGELOG.md

@@ -1,6 +1,7 @@
 # 6.0
 
 - Drop support for nodes before v20
+- Add `--version` to CLI
 
 # 5.0
 

README.md

@@ -178,14 +178,15 @@ Synchronous form of `rimraf.moveRemove()`
 ### Command Line Interface
 
 ```
-rimraf version 4.3.0
+rimraf version 6.0.1
 
 Usage: rimraf <path> [<path> ...]
 Deletes all files and folders at "path", recursively.
 
 Options:
   --                   Treat all subsequent arguments as paths
   -h --help            Display this usage info
+  --version            Display version
   --preserve-root      Do not remove '/' recursively (default)
   --no-preserve-root   Do not treat '/' specially
   -G --no-glob         Treat arguments as literal paths, not globs (default)

src/bin.mts

@@ -20,6 +20,7 @@ Deletes all files and folders at "path", recursively.
 Options:
   --                   Treat all subsequent arguments as paths
   -h --help            Display this usage info
+  --version            Display version
   --preserve-root      Do not remove '/' recursively (default)
   --no-preserve-root   Do not treat '/' specially
   -G --no-glob         Treat arguments as literal paths, not globs (default)
@@ -158,6 +159,9 @@ const main = async (...args: string[]) => {
     } else if (arg === '-h' || arg === '--help') {
       console.log(help)
       return 0
+    } else if (arg === '--version') {
+      console.log(version)
+      return 0
     } else if (arg === '--interactive' || arg === '-i') {
       interactive = true
       continue
@@ -258,6 +262,7 @@ const main = async (...args: string[]) => {
   return 0
 }
 main.help = help
+main.version = version
 
 export default main
 

test/bin.ts

@@ -50,6 +50,19 @@ t.test('basic arg parsing stuff', async t => {
     CALLS.length = 0
   })
 
+  t.test('binary version', t => {
+    const cases = [['--version'], ['a', 'b', '--version', 'c']]
+    for (const c of cases) {
+      t.test(c.join(' '), async t => {
+        t.equal(await bin(...c), 0)
+        t.same(LOGS, [[bin.version]])
+        t.same(ERRS, [])
+        t.same(CALLS, [])
+      })
+    }
+    t.end()
+  })
+
   t.test('helpful output', t => {
     const cases = [['-h'], ['--help'], ['a', 'b', '--help', 'c']]
     for (const c of cases) {