copy-file-util 1.3.2 → 1.3.3

package/README.md

@@ -20,13 +20,17 @@ $ npm install --save-dev copy-file-util
 ```
 
 ## B) Usage
-### 1. npm package.json scripts
-Run `copy-file` from the `"scripts"` section of your **package.json** file.
-
+### 1. Synopsis
+```
+copy-file [SOURCE] [TARGET]
+```
 Parameters:
 * The **first** parameter is the *source* file.
 * The **second** parameter is the *target* file or folder (use the `--folder` flag).
 
+### 2. npm package.json scripts
+Run `copy-file` from the `"scripts"` section of your **package.json** file.
+
 Example **package.json** scripts:
 ```json
    "scripts": {
@@ -35,7 +39,7 @@ Example **package.json** scripts:
    },
 ```
 
-### 2. Command-line npx
+### 3. Command-line npx
 Example terminal commands:
 ```shell
 $ npm install --save-dev copy-file-util
@@ -43,7 +47,7 @@ $ copy-file src/web/api.html docs/api-manual.html
 ```
 You can also install **copy-file-util** globally (`--global`) and then run it anywhere directly from the terminal.
 
-### 3. CLI flags
+### 4. CLI flags
 Command-line flags:
 | Flag             | Description                                      | Values     |
 | ---------------- | ------------------------------------------------ | ---------- |
@@ -55,7 +59,7 @@ Command-line flags:
 | `--platform-eol` | Save target file with OS dependent line endings. | N/A        |
 | `--quiet`        | Suppress informational messages.                 | N/A        |
 
-### 4. Examples
+### 5. Examples
    - `copy-file app.js app.mjs --quiet`<br>
    Displays no output.
 
@@ -75,9 +79,10 @@ Command-line flags:
    - `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._
+> [!NOTE]
+> _Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
-### 5. Template variables
+### 6. Template variables
 The *target* parameter can contain template variables, like `{{package.version}}` and `{{package.name}}`, which will be replaced with values with values from your project's **package.json** file.
 
 Example:

package/bin/cli.js

@@ -4,22 +4,6 @@
 // MIT License    //
 ////////////////////
 
-// Usage in package.json:
-//    "scripts": {
-//       "pub-license": "copy-file src/LICENSE doc/license.txt"
-//    },
-//
-// Usage from command line:
-//    $ npm install --save-dev copy-file-util
-//    $ copy-file src/LICENSE doc/license.txt
-//
-// Contributors to this project:
-//    $ cd copy-file-util
-//    $ npm install
-//    $ npm test
-//    $ node bin/cli.js --cd=spec/fixtures mock.html --folder target/to-folder
-//    $ node bin/cli.js --cd=spec/fixtures mock.html target/{{package.type}}/{{package.name}}-v{{package.version}}.html
-
 import { copyFile } from '../dist/copy-file.js';
 
 copyFile.cli();

package/dist/copy-file.d.ts

@@ -1,4 +1,4 @@
-//! copy-file-util v1.3.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.3.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 export type Settings = {
     cd: string | null;
@@ -17,7 +17,7 @@ export type Result = {
     skipped: boolean;
 };
 declare const copyFile: {
-    assert(condition: unknown, errorMessage: unknown): void;
+    assert(ok: unknown, message: string | null): void;
     cli(): void;
     cp(sourceFile: string, options?: Partial<Settings>): Result;
     reporter(result: Result): Result;

package/dist/copy-file.js

@@ -1,4 +1,4 @@
-//! copy-file-util v1.3.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.3.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 import { cliArgvUtil } from 'cli-argv-util';
 import { dna } from 'dna-engine';
@@ -9,9 +9,9 @@ import log from 'fancy-log';
 import path from 'path';
 import slash from 'slash';
 const copyFile = {
-    assert(condition, errorMessage) {
-        if (!condition)
-            throw new Error('[copy-file-util] ' + String(errorMessage));
+    assert(ok, message) {
+        if (!ok)
+            throw new Error(`[copy-file-util] ${message}`);
     },
     cli() {
         const validFlags = ['cd', 'folder', 'move', 'no-overwrite', 'note', 'platform-eol', 'quiet'];
@@ -23,13 +23,13 @@ const copyFile = {
             const value = dna.util.value({ package: pkg }, substring.replace(/[{}]/g, ''));
             return value ?? 'MISSING-FIELD-ERROR';
         };
-        const errorMessage = cli.invalidFlag ? cli.invalidFlagMsg :
+        const error = cli.invalidFlag ? cli.invalidFlagMsg :
             cli.paramCount > 2 ? 'Extraneous parameter: ' + cli.params[2] :
                 !source ? 'Missing source file.' :
                     !target && cli.flagOn.folder ? 'Missing target folder.' :
                         !target ? 'Missing target file.' :
                             null;
-        copyFile.assert(!errorMessage, errorMessage);
+        copyFile.assert(!error, error);
         const templateVariables = /{{[^{}]*}}/g;
         const targetValue = target.replace(templateVariables, getPkgField);
         const options = {
@@ -75,7 +75,7 @@ const copyFile = {
         if (targetFolder)
             fs.mkdirSync(targetFolder, { recursive: true });
         const badTargetFolder = !targetFolder || !fs.existsSync(targetFolder);
-        const errorMessage = settings.fileExtension ? 'Option "fileExtension" not yet implemented.' :
+        const error = settings.fileExtension ? 'Option "fileExtension" not yet implemented.' :
             !sourceFile ? 'Must specify the source file.' :
                 !sourceExists ? 'Source file does not exist: ' + source :
                     !sourceIsFile ? 'Source is not a file: ' + source :
@@ -83,7 +83,7 @@ const copyFile = {
                             doubleTarget ? 'Target cannot be both a file and a folder.' :
                                 badTargetFolder ? 'Target folder cannot be written to: ' + String(targetFolder) :
                                     null;
-        copyFile.assert(!errorMessage, errorMessage);
+        copyFile.assert(!error, error);
         const createTarget = () => {
             if (settings.move)
                 fs.renameSync(source, target);
@@ -105,12 +105,10 @@ const copyFile = {
     },
     reporter(result) {
         const name = chalk.gray('copy-file');
-        const origin = chalk.blue.bold(result.origin);
-        const dest = chalk.magenta(result.dest);
-        const arrow = chalk.gray.bold('→');
+        const ancestor = cliArgvUtil.calcAncestor(result.origin, result.dest);
         const status = result.skipped ? ', skip -- target exists' : result.moved ? ', move' : '';
         const info = chalk.white(`(${result.duration}ms${status})`);
-        log(name, origin, arrow, dest, info);
+        log(name, ancestor.message, info);
         return result;
     },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "copy-file-util",
-   "version": "1.3.2",
+   "version": "1.3.3",
    "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",
@@ -59,7 +59,7 @@
    },
    "dependencies": {
       "chalk": "~5.6",
-      "cli-argv-util": "~1.3",
+      "cli-argv-util": "~1.4",
       "dna-engine": "~3.3",
       "fancy-log": "~2.0",
       "slash": "~5.1"
@@ -67,7 +67,7 @@
    "devDependencies": {
       "@eslint/js": "~9.39",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.10",
+      "@types/node": "~25.0",
       "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "eslint": "~9.39",
@@ -76,6 +76,6 @@
       "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
       "typescript": "~5.9",
-      "typescript-eslint": "~8.46"
+      "typescript-eslint": "~8.50"
    }
 }