copy-file-util 1.1.1 → 1.1.3

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

@@ -60,9 +60,14 @@ 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.
 
+_**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.
 
@@ -71,7 +76,7 @@ Example:
    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
@@ -86,7 +91,7 @@ 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_

package/bin/cli.js

@@ -24,9 +24,7 @@
 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', 'move', 'note', 'quiet'];
@@ -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${result.moved ? ', move' : ''})`);
-   log(name, origin, arrow, dest, info);
-   };
-
 // Copy File
 const error =
    cli.invalidFlag ?              cli.invalidFlagMsg :
@@ -67,4 +55,4 @@ const options = {
    };
 const result = copyFile.cp(source, options);
 if (!cli.flagOn.quiet)
-   printReport(result);
+   copyFile.reporter(result);

package/dist/copy-file.d.ts

@@ -1,6 +1,6 @@
-//! copy-file-util v1.1.1 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.1.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
-export type Options = {
+export type Settings = {
     cd: string;
     targetFile: string;
     targetFolder: string;
@@ -14,6 +14,7 @@ export type Result = {
     moved: boolean;
 };
 declare const copyFile: {
-    cp(sourceFile: string, options: Partial<Options>): Result;
+    cp(sourceFile: string, options?: Partial<Settings>): Result;
+    reporter(result: Result): Result;
 };
 export { copyFile };

package/dist/copy-file.js

@@ -1,6 +1,8 @@
-//! copy-file-util v1.1.1 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v1.1.3 ~~ 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 = {
@@ -50,5 +52,14 @@ const copyFile = {
             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.1",
+   "version": "1.1.3",
    "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",
@@ -82,22 +85,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.5",
-      "@typescript-eslint/eslint-plugin": "~6.4",
-      "@typescript-eslint/parser": "~6.4",
-      "add-dist-header": "~1.2",
+      "@types/node": "~20.10",
+      "@typescript-eslint/eslint-plugin": "~6.17",
+      "@typescript-eslint/parser": "~6.17",
+      "add-dist-header": "~1.3",
       "assert-deep-strict-equal": "~1.1",
-      "eslint": "~8.47",
+      "eslint": "~8.56",
       "jshint": "~2.13",
       "mocha": "~10.2",
       "rimraf": "~5.0",
       "run-scripts-util": "~1.2",
-      "typescript": "~5.1"
+      "typescript": "~5.3"
    }
 }