doc:
  short_help: Ensure a file or folder is absent.
  help: "Ensure a file or folder is absent.\nIf the path is a folder, it will be deleted recursively."
  examples:
  - title: Delete a file (if it exists), using root privileges.
    vars:
      path: /usr/bin/freckles.sh
      become: true
  - title: Delete a file (if it exists).
    vars:
      path: /tmp/freckles.sh
args:
  path:
    doc:
      short_help: The path.
    type: string
    required: true
    empty: false
    cli:
      param_type: argument
  become:
    doc:
      short_help: Whether to use elevated privileges when deleting a file/tree.
    type: boolean
    required: false
    default: false

frecklets:

- task:
    become: '{{:: become ::}}'
  frecklet:
    name: file
    type: ansible-module
    desc:
      short: 'delete file (if exists): {{:: path ::}}'
      long: |
        Delete file or folder '{{:: path ::}}' if it exists (recursively, if folder).
      references:
        "'file' Ansible module": https://docs.ansible.com/ansible/latest/modules/file_module.html
    properties:
      idempotent: true
      internet: false
      elevated: '{{:: become ::}}'
  vars:
    path: '{{:: path ::}}'
    state: absent


meta: {}