copy-file-util 0.1.5 → 0.1.7

package/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Individual contributors to copy-file-util
+Copyright (c) 2022-2023 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

@@ -45,7 +45,7 @@ $ npm install --global copy-file-util
 $ copy-file src/web/api.html docs/api-manual.html
 ```
 
-### 3. CLI Flags
+### 3. CLI flags
 Command-line flags:
 | Flag       | Description                                    | Values     |
 | ---------- | ---------------------------------------------- | ---------- |
@@ -58,7 +58,7 @@ Examples:
    - `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
+### 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:

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', 'note', '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.5 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.7 ~~ 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.5 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.7 ~~ 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.5 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.7 ~~ 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.5",
+   "version": "0.1.7",
    "description": "Copy or rename a file with optional package version number (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
@@ -79,7 +79,8 @@
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
-      "chalk": "~5.1",
+      "chalk": "~5.2",
+      "cli-argv-util": "~0.1",
       "dna-engine": "~2.2",
       "fancy-log": "~2.0",
       "slash": "~5.0"
@@ -87,16 +88,16 @@
    "devDependencies": {
       "@types/fancy-log": "~2.0",
       "@types/node": "~18.11",
-      "@typescript-eslint/eslint-plugin": "~5.42",
-      "@typescript-eslint/parser": "~5.42",
+      "@typescript-eslint/eslint-plugin": "~5.48",
+      "@typescript-eslint/parser": "~5.48",
       "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
       "cpy-cli": "~4.2",
-      "eslint": "~8.27",
+      "eslint": "~8.31",
       "jshint": "~2.13",
-      "mocha": "~10.1",
-      "rimraf": "~3.0",
+      "mocha": "~10.2",
+      "rimraf": "~4.0",
       "run-scripts-util": "~0.1",
-      "typescript": "~4.8"
+      "typescript": "~4.9"
    }
 }