copy-file-util 0.1.4 → 0.1.6

package/README.md

@@ -51,10 +51,11 @@ Command-line flags:
 | ---------- | ---------------------------------------------- | ---------- |
 | `--cd`     | Change working directory before starting copy. | **string** |
 | `--folder` | Indicates the target is a folder.              | N/A        |
+| `--note`   | Place to add a comment only for humans.        | **string** |
 | `--quiet`  | Suppress informational messages.               | N/A        |
 
 Examples:
-   - `copy-file app.js app.mjs --quite`   Displays no output.
+   - `copy-file app.js app.mjs --quiet`   Displays no output.
    - `copy-file app.js --folder dist`   Copies **app.js** into the **dist** folder.
 
 ### 4. Template Variables
@@ -84,6 +85,7 @@ See the **TypeScript Declarations** at the top of [copy-file.ts](copy-file.ts) f
    - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):  _Recursively copy files from one folder to another folder_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):  _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):  _Revision web asset filenames with cache busting content hash fingerprints_
+   - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):  _Organize npm scripts into named groups of easy to manage commands_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):  _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -21,24 +21,18 @@
 //    $ node bin/cli.js --cd=spec/fixtures source/mock.html target/{{pkg.type}}/{{pkg.name}}-v{{pkg.version}}.html
 
 // Imports
+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';
 
-// Parameters
-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];
+// Parameters and flags
+const validFlags = ['cd', 'folder', 'note', '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'));
@@ -50,26 +44,26 @@ 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(' ⟹  ');  //extra space for alignment
+   const arrow =  chalk.gray.bold('→');
    const info =   chalk.white(`(${result.duration}ms)`);
    log(name, origin, arrow, dest, info);
    };
 
 // Copy File
 const error =
-   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.' :
+   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 Error('[copy-file-util] ' + error);
-const targetKey = flagOn.folder ? 'targetFolder' : 'targetFile';
+const targetKey = cli.flagOn.folder ? 'targetFolder' : 'targetFile';
 const options = {
-   cd:          flagMap.cd ?? null,
+   cd:          cli.flagMap.cd ?? null,
    [targetKey]: target.replace(/{{[^{}]*}}/g, getPackageField),
    };
 const result = copyFile.cp(source, options);
-if (!flagOn.quiet)
+if (!cli.flagOn.quiet)
    printReport(result);

package/dist/copy-file.d.ts

@@ -1,13 +1,13 @@
-//! copy-file-util v0.1.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.6 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
-export declare type Settings = {
+export type Settings = {
     cd: string;
     targetFile: string;
     targetFolder: string;
     fileExtension: string;
 };
-export declare type Options = Partial<Settings>;
-export declare type Result = {
+export type Options = Partial<Settings>;
+export type Result = {
     origin: string;
     dest: string;
     duration: number;

package/dist/copy-file.js

@@ -1,4 +1,4 @@
-//! copy-file-util v0.1.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.6 ~~ 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.4 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.6 ~~ 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,6 +1,6 @@
 {
    "name": "copy-file-util",
-   "version": "0.1.4",
+   "version": "0.1.6",
    "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
@@ -63,36 +63,41 @@
          "@typescript-eslint/no-non-null-assertion": "off"
       }
    },
+   "runScriptsConfig": {
+      "build": [
+         "rimraf build dist spec/fixtures/target **/.DS_Store",
+         "jshint . --exclude-path .gitignore",
+         "eslint --max-warnings 0 . --ext .ts",
+         "tsc",
+         "tsc --module UMD --outDir build/umd",
+         "cpy build/umd/copy-file.js build --rename=copy-file.umd.cjs --flat=true",
+         "add-dist-header build dist"
+      ]
+   },
    "scripts": {
-      "step:01": "rimraf build dist spec/fixtures/target **/.DS_Store",
-      "step:02": "jshint . --exclude-path .gitignore",
-      "step:03": "eslint --max-warnings 0 . --ext .ts",
-      "step:04": "tsc",
-      "step:05": "tsc --module UMD --outDir build/umd",
-      "step:06": "cpy build/umd/copy-file.js build --rename=copy-file.umd.cjs --flat=true",
-      "step:07": "add-dist-header build dist",
-      "pretest": "npm-run-all step:*",
+      "pretest": "run-scripts build",
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
       "chalk": "~5.1",
+      "cli-argv-util": "~0.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.40",
-      "@typescript-eslint/parser": "~5.40",
+      "@types/node": "~18.11",
+      "@typescript-eslint/eslint-plugin": "~5.43",
+      "@typescript-eslint/parser": "~5.43",
       "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
       "cpy-cli": "~4.2",
-      "eslint": "~8.25",
+      "eslint": "~8.28",
       "jshint": "~2.13",
-      "mocha": "~10.0",
-      "npm-run-all2": "~6.0",
+      "mocha": "~10.1",
       "rimraf": "~3.0",
-      "typescript": "~4.8"
+      "run-scripts-util": "~0.1",
+      "typescript": "~4.9"
    }
 }