copy-file-util 0.1.3 → 0.1.4

package/README.md

@@ -1,14 +1,15 @@
 # copy-file-util
 <img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
 
-_Copy or rename a file (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 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)
 [![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.  The command's console output includes a timestamp and formatting helpful in build systems.
+**copy-file-util** takes a source file and copies it to a new destination.&nbsp;
+The command's console output includes a timestamp and formatting helpful in build systems.
 
 <img src=https://raw.githubusercontent.com/center-key/copy-file-util/main/screenshot.png
 width=800 alt=screenshot>
@@ -23,8 +24,9 @@ $ npm install --save-dev copy-file-util
 ### 1. npm scripts
 Run `copy-file` from the `"scripts"` section of your **package.json** file.
 
-The **first** parameter is the *source* file.
-The **second** parameter is the *target* file or folder (use the `--folder` flag).
+Parameters:
+* The **first** parameter is the *source* file.
+* The **second** parameter is the *target* file or folder (use the `--folder` flag).
 
 Example **package.json** scripts:
 ```json
@@ -33,7 +35,6 @@ Example **package.json** scripts:
       "backup-license": "copy-file src/LICENSE --folder backup",
    },
 ```
-Try out the first script with the command: `npm run pub-license`
 
 ### 2. Global
 You can install **copy-file-util** globally and then run it anywhere directly from the terminal.
@@ -56,8 +57,14 @@ Examples:
    - `copy-file app.js app.mjs --quite` &nbsp; Displays no output.
    - `copy-file app.js --folder dist` &nbsp; Copies **app.js** into the **dist** folder.
 
+### 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.
+
 ## C) Application Code
-Even though **copy-file-util** is primarily intended for build scripts, the package can easily be used in ESM and TypeScript projects.
+Even though **copy-file-util** is primarily intended for build scripts, the package can easily be used programmatically in ESM and TypeScript projects.
 
 Example:
 ``` typescript
@@ -71,10 +78,11 @@ See the **TypeScript Declarations** at the top of [copy-file.ts](copy-file.ts) f
 <br>
 
 ---
-**Build Tools**
+**CLI Build Tools**
    - 🎋 [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 (CLI tool designed for use in npm scripts)_
-   - 📂 [copy-folder-cli](https://github.com/center-key/copy-folder-cli):&nbsp; _Recursively copy a folder (CLI tool designed for use in npm scripts)_
+   - 📄 [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_
+   - 🔍 [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_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):&nbsp; _Check the markup validity of HTML files using the W3C validator_
 

package/bin/cli.js

@@ -17,10 +17,12 @@
 //    $ cd copy-file-util
 //    $ npm install
 //    $ npm test
-//    $ node bin/cli.js --cd=spec/fixtures source/mock.txt --folder target/to-folder
+//    $ 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/{{pkg.type}}/{{pkg.name}}-v{{pkg.version}}.html
 
 // Imports
 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';
@@ -30,17 +32,18 @@ const validFlags =  ['cd', 'folder', 'quiet'];
 const args =        process.argv.slice(2);
 const flags =       args.filter(arg => /^--/.test(arg));
 const flagMap =     Object.fromEntries(flags.map(flag => flag.replace(/^--/, '').split('=')));
+const flagOn =      Object.fromEntries(validFlags.map(flag => [flag, flag in flagMap]));
 const invalidFlag = Object.keys(flagMap).find(key => !validFlags.includes(key));
 const params =      args.filter(arg => !/^--/.test(arg));
 
 // Data
 const source = params[0];
 const target = params[1];
-const mode =   { folder: 'folder' in flagMap, quiet: 'quiet' in flagMap };
 
 // Utilities
-const getPackageVersion = () => !fs.existsSync('package.json') ? 'ERROR' :
-   JSON.parse(fs.readFileSync('package.json', 'utf-8')).version;
+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) => {
@@ -54,19 +57,19 @@ const printReport = (result) => {
 
 // Copy File
 const error =
-   invalidFlag ?            'Invalid flag: ' + invalidFlag :
-   params.length > 2 ?      'Extraneous parameter: ' + params[2] :
-   !source ?                'Missing source file.' :
-   !target && mode.folder ? 'Missing target folder.' :
-   !target ?                'Missing target file.' :
+   invalidFlag ?              'Invalid flag: ' + invalidFlag :
+   params.length > 2 ?        'Extraneous parameter: ' + params[2] :
+   !source ?                  'Missing source file.' :
+   !target && flagOn.folder ? 'Missing target folder.' :
+   !target ?                  'Missing target file.' :
    null;
 if (error)
    throw Error('[copy-file-util] ' + error);
-const targetKey = mode.folder ? 'targetFolder' : 'targetFile';
+const targetKey = flagOn.folder ? 'targetFolder' : 'targetFile';
 const options = {
    cd:          flagMap.cd ?? null,
-   [targetKey]: target.replace(/{{{pkg.version}}}/, getPackageVersion),
+   [targetKey]: target.replace(/{{[^{}]*}}/g, getPackageField),
    };
 const result = copyFile.cp(source, options);
-if (!mode.quiet)
+if (!flagOn.quiet)
    printReport(result);

package/dist/copy-file.d.ts

@@ -1,4 +1,4 @@
-//! copy-file-util v0.1.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 export declare type Settings = {
     cd: string;

package/dist/copy-file.js

@@ -1,4 +1,4 @@
-//! copy-file-util v0.1.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 import fs from 'fs';
 import path from 'path';

package/dist/copy-file.umd.cjs

@@ -1,4 +1,4 @@
-//! copy-file-util v0.1.3 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "copy-file-util",
-   "version": "0.1.3",
-   "description": "Copy or rename a file (CLI tool designed for use in npm scripts)",
+   "version": "0.1.4",
+   "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
    "module": "dist/copy-file.js",
@@ -75,19 +75,20 @@
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
-      "chalk": "~5.0",
+      "chalk": "~5.1",
+      "dna-engine": "~2.2",
       "fancy-log": "~2.0",
       "slash": "~5.0"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
       "@types/node": "~18.8",
-      "@typescript-eslint/eslint-plugin": "~5.39",
-      "@typescript-eslint/parser": "~5.39",
+      "@typescript-eslint/eslint-plugin": "~5.40",
+      "@typescript-eslint/parser": "~5.40",
       "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
       "cpy-cli": "~4.2",
-      "eslint": "~8.24",
+      "eslint": "~8.25",
       "jshint": "~2.13",
       "mocha": "~10.0",
       "npm-run-all2": "~6.0",