How to use package.json scripts to copy files with specific file extension

Using scripts in package.json to copy files with specific extensions is a practical approach, especially useful for automating common tasks during development. Here are the steps to set up and use package.json scripts for this task:

Step 1: Install the Required npm Package

First, we need a tool for copying files. cpy-cli is a popular choice due to its simplicity and power. We can install it using npm or yarn:

bash
npm install --save-dev cpy-cli

or using yarn:

bash
yarn add --dev cpy-cli

Step 2: Write the Script

After installing cpy-cli, add a new script to the scripts section of package.json. For example, to copy all .txt files to a directory named backup:

json
"scripts": {
  "copy-txt": "cpy '**/*.txt' ../backup --parents"
}

Here, the script "copy-txt" uses the command-line interface of cpy-cli. '**/*.txt' is a glob pattern that matches all .txt files. ../backup specifies the target directory, and the --parents parameter preserves the original directory structure.

Step 3: Run the Script

Once the script is ready, execute it with the following command:

bash
npm run copy-txt

or using yarn:

bash
yarn copy-txt

This command copies all matched .txt files to the backup directory while preserving their directory structure.

Example Use Case

Suppose you are developing a document processing system that requires regular backups of document files (e.g., .txt). Using the above script, you can easily back up all documents to a separate directory, improving data security and maintainability.

This method is not limited to .txt files; it can be applied to other file types by simply modifying the matching file extension.

Summary

Using package.json scripts to manage file copying tasks offers a concise and efficient way to automate repetitive tasks in the development workflow. With tools like cpy-cli, we can easily extend and maintain these scripts to adapt to evolving project requirements.