Son CV dans un terminal web en Javascript! https://terminal-cv.gregandev.fr
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

100 lines
2.1 KiB

# parcel-reporter-static-files-copy
ParcelJS v2 plugin to copy static files from some directory to output dir. There is no watcher -
files are copied on build finish.
## Install
```
yarn add parcel-reporter-static-files-copy --dev
```
```
npm install -D parcel-reporter-static-files-copy
```
## Usage
1. Create `static` directory in your project root.
2. Fill it with your static files
3. Add plugin to `.parcelrc`:
```
{
"extends": ["@parcel/config-default"],
"reporters": ["...", "parcel-reporter-static-files-copy"]
}
```
PLEASE NOTE: `"..."` is not a placeholder - it is used to extend default list of
plugins (reporters in this case). Please see
[Parcel's plugins documentation](https://parceljs.org/features/plugins/#plugins) for more information.
4. Run build - and that's all! Files from `static` directory will end up in `dist`!
## Customization
Beyond the default settings, you can:
1. Name of the directory to be copied.
```json
// package.json
{
...
"staticFiles": {
"staticPath": "customStatic"
}
```
2. Specify directory to copy static files into
If files from `staticPath` needs to get copied into a subdirectory inside the dist dir -
`staticOutPath` can be used:
```json
// package.json
{
...
"staticFiles": {
"staticOutPath": "vendor"
}
```
3. Destination of static files
Destination of static files can be set in plugin configuration. It will override
`--dist-dir` parameter.
```json
// package.json
{
...
"staticFiles": {
"distDir": "customDist"
}
```
### Additional example
Check [examples](https://github.com/elwin013/parcel-reporter-static-files-copy/tree/master/examples) directory for
additional examples.
## Flaws and problems
At this moment this plugin copies all static files from some static dir to output (dist) directory. There is no
watcher on static files - only trigger is finishing build (no matter if normal build or serving).
## Contribute
You're interested in contributing? Awesome! Fork, make change, commit and create pull request. I'll do my best to merge
changes!
## Thanks and acknowledgement
Special thanks to [@gmougeolle](https://github.com/gmougeolle/).
## License
[MIT](/LICENSE)