Action "fs.remove"

Recursively remove files, directories and links. This is a much more aggressive version of unlink based on the rm command.

Output

err
Error object if any.
status
Value is true if files were removed.

Implementation details

Files are removed localling using the Unix "rm" utility.

Simple example

const {$status} = await nikita.fs.remove('./some/dir')
console.info(`Directory was removed: ${$status}`)

Removing a directory unless a given file exists

const {$status} = await nikita.fs.remove({
  $unless_exists: './some/file',
  target: './some/dir'
})
console.info(`Directory was removed: ${$status}`)

Removing multiple files and directories

const {$status} = await nikita.fs.remove([
  { $unless_exists: './some/file', target: './some/dir' },
  './some/file'
])
console.info(`Directories was removed: ${$status}`)

Schema definitions

definitions =
  config:
    type: 'object'
    properties:
      'recursive':
        type: 'boolean'
        description: '''
        Attempt to remove the file hierarchy rooted in the directory.
        Attempting to remove a non-empty directory without the `recursive`
        config will throw an Error.
        '''
      'target':
        type: 'string'
        description: '''
        File, directory or glob (pattern matching based on wildcard
        characters).
        '''
    required: ['target']

Handler

handler = ({config, tools: {log}}) ->
  # Start real work
  {files} = await @fs.glob config.target
  for file in files
    log message: "Removing file #{file}", level: 'INFO'
    try
      {status} = await @execute
        command: [
          'rm'
          '-d' # Attempt to remove directories as well as other types of files.
          '-r' if config.recursive
          file
          # "rm -rf '#{file}'"
        ].join ' '
      log message: "File #{file} removed", level: 'WARN' if status
    catch err
      err.message = [
        'failed to remove the file, got message'
        JSON.stringify err.stderr.trim()
      ].join ' ' if utils.string.lines(err.stderr.trim()).length is 1
      throw err
  {}

Exports

module.exports =
  handler: handler
  metadata:
    argument_to_config: 'target'
    definitions: definitions

Dependencies

utils = require '../../utils'

Edit on GitHub