copy-file-util 1.1.2 → 1.2.0

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 Individual contributors to copy-file-util
+Copyright (c) 2022-2024 Individual contributors to copy-file-util
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,7 @@
 # copy-file-util
 <img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
 
-_Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)_
+_Copy or rename a file with optional package version number (CLI tool designed for use in npm package.json scripts)_
 
 [![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/center-key/copy-file-util/blob/main/LICENSE.txt)
 [![npm](https://img.shields.io/npm/v/copy-file-util.svg)](https://www.npmjs.com/package/copy-file-util)
@@ -20,7 +20,7 @@ $ npm install --save-dev copy-file-util
 ```
 
 ## B) Usage
-### 1. npm scripts
+### 1. npm package.json scripts
 Run `copy-file` from the `"scripts"` section of your **package.json** file.
 
 Parameters:
@@ -45,13 +45,14 @@ You can also install **copy-file-util** globally (`--global`) and then run it an
 
 ### 3. CLI flags
 Command-line flags:
-| Flag       | Description                                    | Values     |
-| ---------- | ---------------------------------------------- | ---------- |
-| `--cd`     | Change working directory before starting copy. | **string** |
-| `--folder` | Indicates the target is a folder.              | N/A        |
-| `--move`   | Delete the source file after copying it.       | N/A        |
-| `--note`   | Place to add a comment only for humans.        | **string** |
-| `--quiet`  | Suppress informational messages.               | N/A        |
+| Flag             | Description                                    | Values     |
+| ---------------- | ---------------------------------------------- | ---------- |
+| `--cd`           | Change working directory before starting copy. | **string** |
+| `--folder`       | Indicates the target is a folder.              | N/A        |
+| `--move`         | Delete the source file after copying it.       | N/A        |
+| `--note`         | Place to add a comment only for humans.        | **string** |
+| `--quiet`        | Suppress informational messages.               | N/A        |
+| `--no-overwrite` | Abort if target file already exists.           | N/A        |
 
 Examples:
    - `copy-file app.js app.mjs --quiet`<br>
@@ -60,9 +61,17 @@ Examples:
    - `copy-file app.js --folder dist`<br>
    Copies **app.js** into the **dist** folder.
 
+   - `copy-file 'src/Legal Notice.md' --folder dist`<br>
+   Copies a file that has a space in its filename.
+
    - `copy-file app.js --move --folder dist`<br>
    Like the `mv` Unix command.
 
+   - `copy-file default-config.json settings/config.json --no-overwrite`<br>
+   Performs a safe copy that aborts if the **settings/config.json** file already exists.
+
+_**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
+
 ### 4. Template variables
 The *target* parameter can contain template variables, like `{{pkg.version}}` and `{{pkg.name}}`, which will be replaced with values with values from your project's **package.json** file.
 
@@ -93,7 +102,7 @@ See the **TypeScript Declarations** at the top of [copy-file.ts](copy-file.ts) f
    - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):&nbsp; _Run a command on each file in a folder and its subfolders_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):&nbsp; _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
-   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm scripts into named groups of easy to manage commands_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm package.json scripts into named groups of easy to manage commands_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):&nbsp; _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -27,7 +27,7 @@ import { dna } from 'dna-engine';
 import fs from 'fs';
 
 // Parameters and flags
-const validFlags = ['cd', 'folder', 'move', 'note', 'quiet'];
+const validFlags = ['cd', 'folder', 'move', 'no-overwrite', 'note', 'quiet'];
 const cli =        cliArgvUtil.parse(validFlags);
 const source =     cli.params[0];
 const target =     cli.params[1];
@@ -51,6 +51,7 @@ const targetKey = cli.flagOn.folder ? 'targetFolder' : 'targetFile';
 const options = {
    cd:          cli.flagMap.cd ?? null,
    move:        cli.flagOn.move,
+   overwrite:   !cli.flagOn.noOverwrite,
    [targetKey]: target.replace(/{{[^{}]*}}/g, getPackageField),
    };
 const result = copyFile.cp(source, options);

package/dist/copy-file.d.ts

@@ -1,4 +1,4 @@
-//! copy-file-util v1.1.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.2.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 export type Settings = {
     cd: string;
@@ -6,12 +6,14 @@ export type Settings = {
     targetFolder: string;
     fileExtension: string;
     move: boolean;
+    overwrite: boolean;
 };
 export type Result = {
     origin: string;
     dest: string;
     duration: number;
     moved: boolean;
+    skipped: boolean;
 };
 declare const copyFile: {
     cp(sourceFile: string, options?: Partial<Settings>): Result;

package/dist/copy-file.js

@@ -1,4 +1,4 @@
-//! copy-file-util v1.1.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.2.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 import chalk from 'chalk';
 import fs from 'fs';
@@ -13,6 +13,7 @@ const copyFile = {
             targetFolder: null,
             fileExtension: null,
             move: false,
+            overwrite: true,
         };
         const settings = { ...defaults, ...options };
         const startTime = Date.now();
@@ -28,6 +29,8 @@ const copyFile = {
         const targetFolder = targetPath ? normalize(startFolder + targetPath) : null;
         const targetFile = settings.targetFile ?? settings.targetFolder + '/' + sourceFilename;
         const target = normalize(startFolder + targetFile);
+        const targetExists = !missingTarget && fs.existsSync(target);
+        const skip = targetExists && !settings.overwrite;
         if (targetFolder)
             fs.mkdirSync(targetFolder, { recursive: true });
         const badTargetFolder = !targetFolder || !fs.existsSync(targetFolder);
@@ -41,14 +44,15 @@ const copyFile = {
                                     null;
         if (errorMessage)
             throw Error('[copy-file-util] ' + errorMessage);
-        if (settings.move)
+        if (!skip && settings.move)
             fs.renameSync(source, target);
-        else
+        else if (!skip)
             fs.copyFileSync(source, target);
         return {
             origin: source,
             dest: target,
             moved: settings.move,
+            skipped: skip,
             duration: Date.now() - startTime,
         };
     },
@@ -57,7 +61,8 @@ const copyFile = {
         const origin = chalk.blue.bold(result.origin);
         const dest = chalk.magenta(result.dest);
         const arrow = chalk.gray.bold('→');
-        const info = chalk.white(`(${result.duration}ms${result.moved ? ', move' : ''})`);
+        const status = result.skipped ? ', skip -- target exists' : result.moved ? ', move' : '';
+        const info = chalk.white(`(${result.duration}ms${status})`);
         log(name, origin, arrow, dest, info);
         return result;
     },

package/package.json

@@ -1,21 +1,15 @@
 {
    "name": "copy-file-util",
-   "version": "1.1.2",
-   "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)",
+   "version": "1.2.0",
+   "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm package.json scripts)",
    "license": "MIT",
    "type": "module",
    "module": "dist/copy-file.js",
-   "main": "dist/copy-file.js",
    "types": "dist/copy-file.d.ts",
+   "exports": "./dist/copy-file.js",
    "files": [
       "dist"
    ],
-   "exports": {
-      ".": {
-         "import": "./dist/copy-file.js"
-      },
-      "./": "./dist/"
-   },
    "bin": {
       "copy-file": "bin/cli.js",
       "copy-file-util": "bin/cli.js"
@@ -85,22 +79,22 @@
    "dependencies": {
       "chalk": "~5.3",
       "cli-argv-util": "~1.2",
-      "dna-engine": "~3.0",
+      "dna-engine": "~3.1",
       "fancy-log": "~2.0",
       "slash": "~5.1"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/node": "~20.6",
-      "@typescript-eslint/eslint-plugin": "~6.7",
-      "@typescript-eslint/parser": "~6.7",
-      "add-dist-header": "~1.3",
-      "assert-deep-strict-equal": "~1.1",
-      "eslint": "~8.50",
+      "@types/node": "~20.11",
+      "@typescript-eslint/eslint-plugin": "~7.2",
+      "@typescript-eslint/parser": "~7.2",
+      "add-dist-header": "~1.4",
+      "assert-deep-strict-equal": "~1.2",
+      "eslint": "~8.57",
       "jshint": "~2.13",
-      "mocha": "~10.2",
+      "mocha": "~10.3",
       "rimraf": "~5.0",
       "run-scripts-util": "~1.2",
-      "typescript": "~5.2"
+      "typescript": "~5.4"
    }
 }