safe-rm 3.1.1 → 3.1.3

package/bin/rm.sh

@@ -43,7 +43,7 @@ debug(){
 
 
 error(){
-  echo $@ >&2
+  echo "$@" >&2
 }
 
 
@@ -389,6 +389,8 @@ remove(){
         read answer
         if [[ ${answer:0:1} =~ [yY] ]]; then
           [[ $(ls -A "$file") ]] && {
+            debug "$LINENO: $file: Directory not empty: $(ls -A "$file")"
+
             echo "$COMMAND: $file: Directory not empty"
 
             return 1
@@ -427,15 +429,24 @@ remove(){
 
 
 recursive_remove(){
+  local dir=$1
   local path
-
-  # use `ls -A` instead of `for` to list hidden files.
-  # and `for $1/*` is also weird if `$1` is neithor a dir nor existing that will print "$1/*" directly and rudely.
-  # never use `find $1`, for the searching order is not what we want
-  local list=$(ls -A "$1")
-
-  [[ -n $list ]] && for path in "$list"; do
-    remove "$1/$path"
+  local restore_nullglob=$(shopt -p nullglob)
+  local restore_dotglob=$(shopt -p dotglob)
+
+  # Avoid `ls -A` + unquoted `for` iteration, which splits names by IFS
+  # and breaks paths containing spaces (e.g. "a b" -> "a" + "b").
+  # Use glob expansion with arrays to keep each entry as one element.
+  # dotglob includes hidden files, nullglob avoids a literal "$dir/*" token.
+  shopt -s nullglob dotglob
+  local list=("$dir"/*)
+  eval "$restore_nullglob"
+  eval "$restore_dotglob"
+
+  for path in "${list[@]}"; do
+    debug "$LINENO: recursively remove: $path"
+
+    remove "$path"
   done
 }
 
@@ -517,12 +528,19 @@ applescript_trash(){
 
   [[ "$OPT_VERBOSE" == 1 ]] && list_files "$target"
 
+  # #47: Finder alias resolves symlinks to their targets.
+  # For symbolic links, fallback to `mv`-based trash to remove the link itself.
+  if [[ -L "$target" ]]; then
+    debug "$LINENO: symlink detected, fallback to mac_trash: $target"
+    mac_trash "$target"
+    return $?
+  fi
+
   debug "$LINENO: osascript delete $target"
 
   osascript -e "tell application \"Finder\" to delete (POSIX file \"$target\" as alias)" &> /dev/null
 
-  # TODO: handle osascript errors
-  return 0
+  return $?
 }
 
 
@@ -606,11 +624,12 @@ mac_trash(){
 
   debug "$LINENO: mv $move to $trash_path"
   mv "$move" "$trash_path"
+  local status=$?
 
-  [[ "$_traveled" == 1 ]] && cd $__DIRNAME &> /dev/null
+  [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
 
-  # default status
-  return 0
+  # Propagate mv status; otherwise callers may treat move failures as success.
+  return $status
 }
 
 
@@ -630,7 +649,7 @@ check_linux_trash_base(){
     local num=
 
     while IFS= read -r file; do
-      if [[ $file =~ ${filename}\.([0-9]+)$ ]]; then
+      if [[ $file =~ ${base}\.([0-9]+)$ ]]; then
           # Remove leading zeros and make sure the number is in base 10
           num=$((10#${BASH_REMATCH[1]}))
           if ((num > max_n)); then
@@ -664,6 +683,13 @@ linux_trash(){
   # Move the target into the trash
   debug "$LINENO: mv $move to $trash_path"
   mv "$move" "$trash_path"
+  local move_status=$?
+
+  if [[ $move_status -ne 0 ]]; then
+    # Keep failure visible to remove()/EXIT_CODE and skip writing .trashinfo.
+    [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
+    return $move_status
+  fi
 
   # Save linux trash info
   local info_path="$SAFE_RM_TRASH/info/$base.trashinfo"
@@ -673,10 +699,11 @@ linux_trash(){
 Path=$move
 DeletionDate=$trash_time
 EOF
+  local info_status=$?
 
-  [[ "$_traveled" == 1 ]] && cd $__DIRNAME &> /dev/null
+  [[ "$_traveled" == 1 ]] && cd "$__DIRNAME" &> /dev/null
 
-  return 0
+  return $info_status
 }
 
 
@@ -685,15 +712,22 @@ EOF
 #   'coz `find` act a inward searching, unlike rm -v
 list_files(){
   if [[ -d "$1" ]]; then
-    local list=$(ls -A "$1")
+    local restore_nullglob=$(shopt -p nullglob)
+    local restore_dotglob=$(shopt -p dotglob)
+    # Keep traversal behavior aligned with recursive_remove(): no word splitting
+    # for names with spaces, and include dotfiles for rm -v output.
+    shopt -s nullglob dotglob
+    local list=("$1"/*)
+    eval "$restore_nullglob"
+    eval "$restore_dotglob"
     local f
 
-    [[ -n $list ]] && for f in "$list"; do
-      list_files "$1/$f"
+    for f in "${list[@]}"; do
+      list_files "$f"
     done
   fi
 
-  echo $1
+  echo "$1"
 }
 
 

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "safe-rm",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "description": "A much safer replacement of bash rm with nearly full functionalities and options of the rm command!",
   "bin": {
     "safe-rm": "./bin/rm.sh"
   },
   "scripts": {
-    "test": "ava --timeout=10s --verbose",
+    "test:rm": "ava --timeout=10s --verbose test/safe-rm.test.js",
+    "test:as": "ava --timeout=10s --verbose test/safe-rm-as.test.js",
+    "test": "npm run test:rm && npm run test:as",
     "test:dev": "NODE_DEBUG=safe-rm npm run test",
     "test:debug": "SAFE_RM_DEBUG=1 npm run test:dev",
     "test:mock-linux": "SAFE_RM_DEBUG_LINUX=1 npm run test",

package/test/cases.js

@@ -1,4 +1,5 @@
 const path = require('path')
+const fs = require('fs').promises
 const {v4: uuid} = require('uuid')
 const delay = require('delay')
 
@@ -272,4 +273,178 @@ module.exports = (
     t.true(result.stderr.includes('protected'), 'stderr should include "protected"')
     t.true(await pathExists(filepath), 'file should not be removed')
   })
+
+  !is_as(type) && test(`#44: recursively and interactively`, async t => {
+    const {
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const name = 'foo'
+
+    const dir = await createDir({
+      name
+    })
+
+    const fileA = await createFile({
+      name: 'a',
+      under: dir
+    })
+
+    const fileB = await createFile({
+      name: 'b',
+      under: dir
+    })
+
+    const result = await runRm(['-ri', dir], {
+      input: ['y', 'y', 'y', 'y']
+    })
+
+    t.is(result.stderr, '', 'stderr should be empty')
+    t.is(result.code, 0, 'exit code should be 0')
+    t.is(
+      result.stdout,
+      `examine files in directory ${dir}? y
+remove ${fileA}? y
+remove ${fileB}? y
+remove ${dir}? y
+`,
+      'stdout does not match'
+    )
+
+    t.false(await pathExists(dir), 'directory should be removed')
+  })
+
+  !is_as(type) && test(`recursively and interactively with spaces`, async t => {
+    // Regression guard: recursive interactive remove must keep "a b"
+    // as one path and still remove the directory successfully.
+    const {
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const dir = await createDir({
+      name: 'foo'
+    })
+
+    const fileA = await createFile({
+      name: 'a b',
+      under: dir
+    })
+
+    const fileB = await createFile({
+      name: 'c',
+      under: dir
+    })
+
+    const result = await runRm(['-ri', dir], {
+      input: ['y', 'y', 'y', 'y']
+    })
+
+    t.is(result.stderr, '', 'stderr should be empty')
+    t.is(result.code, 0, 'exit code should be 0')
+    t.is(
+      result.stdout,
+      `examine files in directory ${dir}? y
+remove ${fileA}? y
+remove ${fileB}? y
+remove ${dir}? y
+`,
+      'stdout does not match'
+    )
+
+    t.false(await pathExists(dir), 'directory should be removed')
+  })
+
+  !is_as(type) && test(`#47: removes symlink itself instead of target`, async t => {
+    const {
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const target = await createFile({
+      name: 'file1'
+    })
+
+    const link = path.join(path.dirname(target), 'file1_sym')
+    await fs.symlink(target, link)
+
+    const result = await runRm([link])
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(link), 'symlink should be removed')
+    t.true(await pathExists(target), 'target file should remain')
+  })
+
+  !is_as(type) && test(`#47: applescript path should also remove symlink itself`, async t => {
+    const {
+      root,
+      createDir,
+      createFile,
+      runRm,
+      pathExists
+    } = t.context
+
+    const home = await createDir({
+      name: 'home',
+      under: root
+    })
+
+    await createDir({
+      name: '.Trash',
+      under: home
+    })
+
+    const mockBin = await createDir({
+      name: 'mock-bin',
+      under: root
+    })
+
+    // Simulate Finder alias behavior: if safe-rm calls osascript with a symlink,
+    // this mock deletes the resolved target. safe-rm should bypass this for symlinks.
+    const mockOsa = await createFile({
+      name: 'osascript',
+      under: mockBin,
+      content: `#!/usr/bin/env bash
+expr=$2
+target=$(printf '%s' "$expr" | cut -d '"' -f2)
+
+if [[ -L "$target" ]]; then
+  resolved=$(readlink "$target")
+  if [[ "$resolved" != /* ]]; then
+    resolved="$(cd "$(dirname "$target")" && pwd)/$resolved"
+  fi
+  /bin/rm -f "$resolved"
+else
+  /bin/rm -rf "$target"
+fi
+`
+    })
+
+    await fs.chmod(mockOsa, 0o755)
+
+    const target = await createFile({
+      name: 'file2'
+    })
+
+    const link = path.join(path.dirname(target), 'file2_sym')
+    await fs.symlink(target, link)
+
+    const result = await runRm([link], {
+      env: {
+        HOME: home,
+        PATH: `${mockBin}:${process.env.PATH}`,
+        SAFE_RM_TRASH: ''
+      }
+    })
+
+    t.is(result.code, 0, 'exit code should be 0')
+    t.false(await pathExists(link), 'symlink should be removed')
+    t.true(await pathExists(target), 'target file should remain')
+  })
 }

package/test/helper.js

@@ -58,13 +58,13 @@ const generateContextMethods = (
 
   // Helper function to run rm commands
   function runRm (args, {
-    input = '',
+    input = [],
     command = rm_command,
     env: arg_env = {}
   } = {}) {
-    return new Promise(resolve => {
+    return new Promise((resolve, reject) => {
       const env = {
-        // ...process.env,
+        ...process.env,
         ...{
           SAFE_RM_TRASH: t.context.trash_path
         },
@@ -80,21 +80,33 @@ const generateContextMethods = (
 
       child.stdout.on('data', data => {
         stdout += data.toString()
+
+        if (/\?\s*$/.test(stdout)) {
+          if (!child.stdin) {
+            reject(new Error('Child process does not support stdin'))
+            return
+          }
+
+          const this_input = input.shift()
+
+          if (!this_input) {
+            reject(new Error('Need more input'))
+            return
+          }
+
+          child.stdin.write(`${this_input}\n`)
+          stdout += `${this_input}\n`
+
+          if (input.length === 0) {
+            child.stdin.end()
+          }
+        }
       })
 
       child.stderr.on('data', data => {
         stderr += data.toString()
       })
 
-      if (input) {
-        if (!child.stdin) {
-          throw new Error('Child process does not support stdin')
-        }
-
-        child.stdin.write(input)
-        child.stdin.end()
-      }
-
       child.on('close', code => {
         const resolved = {
           code,
@@ -105,6 +117,7 @@ const generateContextMethods = (
         log(command, 'result:', resolved)
 
         resolve(resolved)
+        child.kill()
       })
     })
   }

package/.travis.yml

@@ -1,4 +0,0 @@
-language: bash
-
-script:
-    - make test