copy-file-util 1.3.1 → 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        |
 
-Examples:
+### 5. Examples
    - `copy-file app.js app.mjs --quiet`<br>
    Displays no output.
 
@@ -75,9 +79,10 @@ Examples:
    - `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._
 
-### 4. 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:
@@ -92,7 +97,7 @@ Example:
 import { copyFile } from 'copy-file-util';
 
 const result = copyFile.cp('src/web/api.html' { targetFile: 'docs/api-manual.html' });
-console.log('Execution time:', result.duration, 'ms');
+console.info('Execution time:', result.duration, 'ms');
 ```
 
 See the **TypeScript Declarations** at the top of [copy-file.ts](src/copy-file.ts) for documentation.

package/bin/cli.js

@@ -4,58 +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 source/mock.html --folder target/to-folder
-//    $ node bin/cli.js --cd=spec/fixtures source/mock.html target/{{package.type}}/{{package.name}}-v{{package.version}}.html
-
-// Imports
-import { cliArgvUtil } from 'cli-argv-util';
 import { copyFile } from '../dist/copy-file.js';
-import { dna } from 'dna-engine';
-import fs from 'fs';
-
-// Parameters and flags
-const validFlags = ['cd', 'folder', 'move', 'no-overwrite', 'note', 'platform-eol', 'quiet'];
-const cli =        cliArgvUtil.parse(validFlags);
-const source =     cli.params[0];
-const target =     cli.params[1];
-
-// Utilities
-const readPackage = () => JSON.parse(fs.readFileSync('package.json', 'utf-8'));
-const getPackageField = (match) =>  //example: '{{package.version}}' --> '3.1.4'
-   dna.util.value({ package: readPackage() }, match.replace(/[{}]/g, '')) ?? 'MISSING-FIELD-ERROR';
 
-// Copy File
-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;
-if (error)
-   throw new Error('[copy-file-util] ' + error);
-const targetKey = cli.flagOn.folder ? 'targetFolder' : 'targetFile';
-const templateVariables = /{{[^{}]*}}/g;  //example match: "{{package.version}}"
-const options = {
-   cd:          cli.flagMap.cd ?? null,
-   move:        cli.flagOn.move,
-   overwrite:   !cli.flagOn.noOverwrite,
-   platformEol: cli.flagOn.platformEol,
-   [targetKey]: target.replace(templateVariables, getPackageField),
-   };
-const result = copyFile.cp(source, options);
-if (!cli.flagOn.quiet)
-   copyFile.reporter(result);
+copyFile.cli();

package/dist/copy-file.d.ts

@@ -1,10 +1,10 @@
-//! copy-file-util v1.3.1 ~~ 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;
-    targetFile: string;
-    targetFolder: string;
-    fileExtension: string;
+    cd: string | null;
+    targetFile: string | null;
+    targetFolder: string | null;
+    fileExtension: string | null;
     move: boolean;
     overwrite: boolean;
     platformEol: boolean;
@@ -17,6 +17,8 @@ export type Result = {
     skipped: boolean;
 };
 declare const copyFile: {
+    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,5 +1,7 @@
-//! copy-file-util v1.3.1 ~~ 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';
 import { EOL } from 'node:os';
 import chalk from 'chalk';
 import fs from 'fs';
@@ -7,6 +9,42 @@ import log from 'fancy-log';
 import path from 'path';
 import slash from 'slash';
 const copyFile = {
+    assert(ok, message) {
+        if (!ok)
+            throw new Error(`[copy-file-util] ${message}`);
+    },
+    cli() {
+        const validFlags = ['cd', 'folder', 'move', 'no-overwrite', 'note', 'platform-eol', 'quiet'];
+        const cli = cliArgvUtil.parse(validFlags);
+        const source = cli.params[0];
+        const target = cli.params[1];
+        const getPkgField = (substring) => {
+            const pkg = JSON.parse(fs.readFileSync('package.json', 'utf-8'));
+            const value = dna.util.value({ package: pkg }, substring.replace(/[{}]/g, ''));
+            return value ?? 'MISSING-FIELD-ERROR';
+        };
+        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(!error, error);
+        const templateVariables = /{{[^{}]*}}/g;
+        const targetValue = target.replace(templateVariables, getPkgField);
+        const options = {
+            cd: cli.flagMap.cd ?? null,
+            targetFile: !cli.flagOn.folder ? targetValue : null,
+            targetFolder: cli.flagOn.folder ? targetValue : null,
+            fileExtension: null,
+            move: !!cli.flagOn.move,
+            overwrite: !cli.flagOn.noOverwrite,
+            platformEol: !!cli.flagOn.platformEol,
+        };
+        const result = copyFile.cp(source, options);
+        if (!cli.flagOn.quiet)
+            copyFile.reporter(result);
+    },
     cp(sourceFile, options) {
         const defaults = {
             cd: null,
@@ -20,40 +58,40 @@ const copyFile = {
         const settings = { ...defaults, ...options };
         const startTime = Date.now();
         const missingTarget = !settings.targetFile && !settings.targetFolder;
-        const ambiguousTarget = !!settings.targetFile && !!settings.targetFolder;
-        const normalize = (folder) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, '');
-        const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';
-        const source = sourceFile ? normalize(startFolder + sourceFile) : '';
+        const doubleTarget = !!settings.targetFile && !!settings.targetFolder;
+        const cleanUp = (folder) => slash(path.normalize(folder)).replace(/\/$/, '');
+        const cleanPath = (folder) => !folder ? '' : cleanUp(folder);
+        const startFolder = settings.cd ? cleanPath(settings.cd) + '/' : '';
+        const source = sourceFile ? cleanPath(startFolder + sourceFile) : '';
         const sourceExists = source && fs.existsSync(source);
         const sourceIsFile = sourceExists && fs.statSync(source).isFile();
         const sourceFilename = sourceIsFile ? path.basename(source) : null;
         const targetPath = settings.targetFile ? path.dirname(settings.targetFile) : settings.targetFolder;
-        const targetFolder = targetPath ? normalize(startFolder + targetPath) : null;
+        const targetFolder = targetPath ? cleanPath(startFolder + targetPath) : null;
         const targetFile = settings.targetFile ?? `${settings.targetFolder}/${sourceFilename}`;
-        const target = normalize(startFolder + targetFile);
+        const target = cleanPath(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);
-        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 :
                         missingTarget ? 'Must specify a target file or folder.' :
-                            ambiguousTarget ? 'Target cannot be both a file and a folder.' :
+                            doubleTarget ? 'Target cannot be both a file and a folder.' :
                                 badTargetFolder ? 'Target folder cannot be written to: ' + String(targetFolder) :
                                     null;
-        if (errorMessage)
-            throw new Error('[copy-file-util] ' + errorMessage);
+        copyFile.assert(!error, error);
         const createTarget = () => {
             if (settings.move)
                 fs.renameSync(source, target);
             else
                 fs.copyFileSync(source, target);
-            const osEol = (text) => text.replace(/\r?\n/g, EOL);
+            const platformEol = (text) => text.replace(/\r?\n/g, EOL);
             if (settings.platformEol)
-                fs.writeFileSync(target, osEol(fs.readFileSync(target, 'utf-8')));
+                fs.writeFileSync(target, platformEol(fs.readFileSync(target, 'utf-8')));
         };
         if (!skip)
             createTarget();
@@ -67,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.1",
+   "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",
@@ -42,7 +42,7 @@
    },
    "runScriptsConfig": {
       "clean": [
-         "rimraf build dist spec/fixtures/target"
+         "rimraf build dist spec/target"
       ],
       "lint": [
          "jshint . --exclude-path .gitignore",
@@ -55,27 +55,27 @@
    },
    "scripts": {
       "pretest": "run-scripts clean lint build",
-      "test": "mocha spec/*.spec.js"
+      "test": "mocha spec"
    },
    "dependencies": {
-      "chalk": "~5.4",
-      "cli-argv-util": "~1.3",
-      "dna-engine": "~3.2",
+      "chalk": "~5.6",
+      "cli-argv-util": "~1.4",
+      "dna-engine": "~3.3",
       "fancy-log": "~2.0",
       "slash": "~5.1"
    },
    "devDependencies": {
-      "@eslint/js": "~9.30",
+      "@eslint/js": "~9.39",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.0",
-      "add-dist-header": "~1.4",
+      "@types/node": "~25.0",
+      "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
-      "eslint": "~9.30",
+      "eslint": "~9.39",
       "jshint": "~2.13",
       "mocha": "~11.7",
-      "rimraf": "~6.0",
+      "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
-      "typescript": "~5.8",
-      "typescript-eslint": "~8.36"
+      "typescript": "~5.9",
+      "typescript-eslint": "~8.50"
    }
 }