Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vasekpurchart/phing-copy-files-task

Copy files with better control over copying than the default Phing CopyTask
https://github.com/vasekpurchart/phing-copy-files-task

copy files phing phing-tasks

Last synced: 3 months ago
JSON representation

Copy files with better control over copying than the default Phing CopyTask

Awesome Lists containing this project

README

        

Phing Copy Files Task
=====================

Copy files with better control over copying than the default Phing [`CopyTask`](https://www.phing.info/docs/guide/trunk/CopyTask.html).

The main disadvantage of the default task is that it ignores the `overwrite="false"` setting (which is also default) and if the source file is newer, it always rewrites the target file (see [phingofficial/phing#538](https://github.com/phingofficial/phing/issues/538)). This is unexpected and potentially very dangerous behaviour especially when copying configuration files etc.

`CopyFilesTask` has much narrower use-cases, but offers you more control about the copied files. It works only with files (not directories or filesets) and you can specify how exactly each of the files should be copied and what to do when the target already exists.

Usage
-----

To copy a file you can just write:

```xml



```

The paths are relative to the location of the buildfile. If you want to use absolute paths, you can write paths using `${project.basedir}`, which contains the location of the buildfile.

You can also copy multiple files within one task definition:

```xml




```

### Target file exists mode

If the target file already exists, there are three modes how you can choose that the situation will be handled:

1) `skip` (default) - copying of the file is skipped (and logged to output)
2) `replace` - always replace target file, even if it exists
3) `fail` - do not overwrite the target file and fail the build

You can set the mode for all files at once with `existsmode` parameter on ``:

```xml




```

And also for each ``, meaning it will override the `` setting:

```xml




```

Installation
------------

1) Install package [`vasek-purchart/phing-copy-files-task`](https://packagist.org/packages/vasek-purchart/phing-copy-files-task) with [Composer](https://getcomposer.org/):

```bash
composer require vasek-purchart/phing-copy-files-task
```

2) Register this task under a name of your choosing.

There are several ways how to register a task, see the `TaskDefTask` documentation. The recommended way is putting this in your `build.xml`:

```xml

```

You can pick any other name for the command if you would like to.