copy-file-util 1.1.0 → 1.1.2

package/README.md

@@ -5,7 +5,6 @@ _Copy or rename a file with optional package version number (CLI tool designed f
 
 [![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)
-[![Vulnerabilities](https://snyk.io/test/github/center-key/copy-file-util/badge.svg)](https://snyk.io/test/github/center-key/copy-file-util)
 [![Build](https://github.com/center-key/copy-file-util/workflows/build/badge.svg)](https://github.com/center-key/copy-file-util/actions/workflows/run-spec-on-push.yaml)
 
 **copy-file-util** takes a source file and copies it to a new destination. 
@@ -36,14 +35,13 @@ Example **package.json** scripts:
    },
 ```
 
-### 2. Global
-You can install **copy-file-util** globally and then run it anywhere directly from the terminal.
-
+### 2. Command-line npx
 Example terminal commands:
 ```shell
-$ npm install --global copy-file-util
+$ npm install --save-dev copy-file-util
 $ 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
 Command-line flags:
@@ -51,6 +49,7 @@ Command-line flags:
 | ---------- | ---------------------------------------------- | ---------- |
 | `--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        |
 
@@ -61,14 +60,18 @@ Examples:
    - `copy-file app.js --folder dist`<br>
    Copies **app.js** into the **dist** folder.
 
+   - `copy-file app.js --move --folder dist`<br>
+   Like the `mv` Unix command.
+
 ### 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.
 
 Example:
-   - `copy-file build/app.js dist/app-v{{pkg.version}}.js` &nbsp; Creates a copy of **app.js** named something like **app-v1.2.3.js** based on the version of your project.
+   - `copy-file build/app.js dist/app-v{{pkg.version}}.js`<br>
+   Creates a copy of **app.js** named something like **app-v1.2.3.js** based on the version of your project.
 
 ## C) Application Code
-Even though **copy-file-util** is primarily intended for build scripts, the package can easily be used programmatically in ESM and TypeScript projects.
+Even though **copy-file-util** is primarily intended for build scripts, the package can be used programmatically in ESM and TypeScript projects.
 
 Example:
 ``` typescript
@@ -83,10 +86,11 @@ See the **TypeScript Declarations** at the top of [copy-file.ts](copy-file.ts) f
 <br>
 
 ---
-**CLI Build Tools**
+**CLI Build Tools for package.json**
    - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Prepend a one-line banner comment (with license notice) to distribution files_
    - 📄 [copy-file-util](https://github.com/center-key/copy-file-util):&nbsp; _Copy or rename a file with optional package version number_
    - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):&nbsp; _Recursively copy files from one folder to another folder_
+   - 🪺 [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_

package/bin/cli.js

@@ -10,7 +10,7 @@
 //    },
 //
 // Usage from command line:
-//    $ npm install --global copy-file-util
+//    $ npm install --save-dev copy-file-util
 //    $ copy-file src/LICENSE doc/license.txt
 //
 // Contributors to this project:
@@ -24,12 +24,10 @@
 import { cliArgvUtil } from 'cli-argv-util';
 import { copyFile } from '../dist/copy-file.js';
 import { dna } from 'dna-engine';
-import chalk from 'chalk';
-import fs    from 'fs';
-import log   from 'fancy-log';
+import fs from 'fs';
 
 // Parameters and flags
-const validFlags = ['cd', 'folder', 'note', 'quiet'];
+const validFlags = ['cd', 'folder', 'move', 'note', 'quiet'];
 const cli =        cliArgvUtil.parse(validFlags);
 const source =     cli.params[0];
 const target =     cli.params[1];
@@ -39,16 +37,6 @@ const readPackage = () => JSON.parse(fs.readFileSync('package.json', 'utf-8'));
 const getPackageField = (match) =>
    dna.util.value({ pkg: readPackage() }, match.replace(/[{}]/g, '')) ?? 'MISSING-FIELD-ERROR';
 
-// Reporting
-const printReport = (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 info =   chalk.white(`(${result.duration}ms)`);
-   log(name, origin, arrow, dest, info);
-   };
-
 // Copy File
 const error =
    cli.invalidFlag ?              cli.invalidFlagMsg :
@@ -62,8 +50,9 @@ if (error)
 const targetKey = cli.flagOn.folder ? 'targetFolder' : 'targetFile';
 const options = {
    cd:          cli.flagMap.cd ?? null,
+   move:        cli.flagOn.move,
    [targetKey]: target.replace(/{{[^{}]*}}/g, getPackageField),
    };
 const result = copyFile.cp(source, options);
 if (!cli.flagOn.quiet)
-   printReport(result);
+   copyFile.reporter(result);

package/dist/copy-file.d.ts

@@ -1,18 +1,20 @@
-//! copy-file-util v1.1.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.1.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 export type Settings = {
     cd: string;
     targetFile: string;
     targetFolder: string;
     fileExtension: string;
+    move: boolean;
 };
-export type Options = Partial<Settings>;
 export type Result = {
     origin: string;
     dest: string;
     duration: number;
+    moved: boolean;
 };
 declare const copyFile: {
-    cp(sourceFile: string, options: Options): Result;
+    cp(sourceFile: string, options?: Partial<Settings>): Result;
+    reporter(result: Result): Result;
 };
 export { copyFile };

package/dist/copy-file.js

@@ -1,18 +1,20 @@
-//! copy-file-util v1.1.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.1.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
+import chalk from 'chalk';
 import fs from 'fs';
+import log from 'fancy-log';
 import path from 'path';
 import slash from 'slash';
 const copyFile = {
     cp(sourceFile, options) {
-        var _a;
         const defaults = {
             cd: null,
             targetFile: null,
             targetFolder: null,
             fileExtension: null,
+            move: false,
         };
-        const settings = Object.assign(Object.assign({}, defaults), options);
+        const settings = { ...defaults, ...options };
         const startTime = Date.now();
         const missingTarget = !settings.targetFile && !settings.targetFolder;
         const ambiguousTarget = !!settings.targetFile && !!settings.targetFolder;
@@ -24,7 +26,7 @@ const copyFile = {
         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 targetFile = (_a = settings.targetFile) !== null && _a !== void 0 ? _a : settings.targetFolder + '/' + sourceFilename;
+        const targetFile = settings.targetFile ?? settings.targetFolder + '/' + sourceFilename;
         const target = normalize(startFolder + targetFile);
         if (targetFolder)
             fs.mkdirSync(targetFolder, { recursive: true });
@@ -39,12 +41,25 @@ const copyFile = {
                                     null;
         if (errorMessage)
             throw Error('[copy-file-util] ' + errorMessage);
-        fs.copyFileSync(source, target);
+        if (settings.move)
+            fs.renameSync(source, target);
+        else
+            fs.copyFileSync(source, target);
         return {
             origin: source,
             dest: target,
+            moved: settings.move,
             duration: Date.now() - startTime,
         };
     },
+    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 info = chalk.white(`(${result.duration}ms${result.moved ? ', move' : ''})`);
+        log(name, origin, arrow, dest, info);
+        return result;
+    },
 };
 export { copyFile };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "copy-file-util",
-   "version": "1.1.0",
+   "version": "1.1.2",
    "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
@@ -20,7 +20,10 @@
       "copy-file": "bin/cli.js",
       "copy-file-util": "bin/cli.js"
    },
-   "repository": "github:center-key/copy-file-util",
+   "repository": {
+      "type": "git",
+      "url": "git+https://github.com/center-key/copy-file-util.git"
+   },
    "homepage": "https://github.com/center-key/copy-file-util",
    "bugs": "https://github.com/center-key/copy-file-util/issues",
    "docs": "https://github.com/center-key/copy-file-util#readme",
@@ -66,37 +69,38 @@
       "clean": [
          "rimraf build dist spec/fixtures/target"
       ],
-      "build": [
+      "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts",
+         "eslint --max-warnings 0 . --ext .ts"
+      ],
+      "build": [
          "tsc",
          "add-dist-header build dist"
       ]
    },
    "scripts": {
-      "pretest": "run-scripts clean build",
+      "pretest": "run-scripts clean lint build",
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
-      "chalk": "~5.2",
-      "cli-argv-util": "~1.0",
+      "chalk": "~5.3",
+      "cli-argv-util": "~1.2",
       "dna-engine": "~3.0",
       "fancy-log": "~2.0",
       "slash": "~5.1"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/node": "~20.3",
-      "@typescript-eslint/eslint-plugin": "~5.60",
-      "@typescript-eslint/parser": "~5.60",
-      "add-dist-header": "~1.0",
-      "assert-deep-strict-equal": "~1.0",
-      "cpy-cli": "~4.2",
-      "eslint": "~8.43",
+      "@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",
       "jshint": "~2.13",
       "mocha": "~10.2",
       "rimraf": "~5.0",
-      "run-scripts-util": "~1.1",
-      "typescript": "~5.1"
+      "run-scripts-util": "~1.2",
+      "typescript": "~5.2"
    }
 }