copy-folder-util 1.1.7 → 1.2.1

package/README.md

@@ -20,13 +20,17 @@ $ npm install --save-dev copy-folder-util
 ```
 
 ## B) Usage
-### 1. npm package.json scripts
-Run `copy-folder` from the `"scripts"` section of your **package.json** file.
-
+### 1. Synopsis
+```
+copy-folder [SOURCE] [TARGET]
+```
 Parameters:
 * The **first** parameter is the *source* folder.
 * The **second** parameter is the *target* folder.
 
+### 2. npm package.json scripts
+Run `copy-folder` from the `"scripts"` section of your **package.json** file.
+
 Example **package.json** scripts:
 ```json
    "scripts": {
@@ -35,7 +39,7 @@ Example **package.json** scripts:
    },
 ```
 
-### 2. Command-line npx
+### 3. Command-line npx
 Example terminal commands:
 ```shell
 $ npm install --save-dev copy-folder-util
@@ -43,7 +47,7 @@ $ npx copy-folder src/web ext=.html docs/api-manual
 ```
 You can also install **copy-folder-util** globally (`--global`) and then run it anywhere directly from the terminal.
 
-### 3. CLI flags
+### 4. CLI flags
 Command-line flags:
 | Flag         | Description                                           | Value      |
 | ------------ | ----------------------------------------------------- | ---------- |
@@ -54,7 +58,7 @@ Command-line flags:
 | `--quiet`    | Suppress informational messages.                      | N/A        |
 | `--summary`  | Only print out the single line summary message.       | N/A        |
 
-### 4. Examples
+### 5. Examples
    - `copy-folder build --basename=index dist` <br>
    Only copies files with filenames matching `index.*`.
 
@@ -62,7 +66,7 @@ Command-line flags:
    Copies the folder **spec/fixtures** to **spec/mock1**.
 
    - `copy-folder build dist --summary`<br>
-   Displays the summary but not the individual files copied.
+   Displays the summary informaion but not informaion about individual files copied.
 
    - `copy-folder 'src/Legal Notices' dist --summary`<br>
    Copies a folder that has a space in its name.
@@ -70,7 +74,8 @@ Command-line flags:
    - `copy-folder src/web --ext=.js,.html docs`<br>
    Copies only the JavaScript and HTML files to the **docs** folder.
 
-_**Note:** Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
+> [!NOTE]
+> _Single quotes in commands are normalized so they work cross-platform and avoid the errors often encountered on Microsoft Windows._
 
 ## C) Application Code
 Even though **copy-folder-util** is primarily intended for build scripts, the package can be used programmatically in ESM and TypeScript projects.

package/bin/cli.js

@@ -4,45 +4,6 @@
 // MIT License      //
 //////////////////////
 
-// Usage in package.json:
-//    "scripts": {
-//       "make-dist": "copy-folder build dist"
-//    },
-//
-// Usage from command line:
-//    $ npm install --save-dev copy-folder-util
-//    $ copy-folder build dist
-//    $ copy-folder src/web --ext=.js,.html docs
-//
-// Contributors to this project:
-//    $ cd copy-folder-util
-//    $ npm install
-//    $ npm test
-//    $ node bin/cli.js --cd=spec/fixtures source --ext=.js target/ext-js
-
-// Imports
-import { cliArgvUtil } from 'cli-argv-util';
 import { copyFolder } from '../dist/copy-folder.js';
 
-// Parameters and Flags
-const validFlags = ['cd', 'ext', 'note', 'quiet', 'summary'];
-const cli =        cliArgvUtil.parse(validFlags);
-const source =     cli.params[0];
-const target =     cli.params[1];
-
-// Copy Folder
-const error =
-   cli.invalidFlag ?    cli.invalidFlagMsg :
-   !source ?            'Missing source folder.' :
-   !target ?            'Missing target folder.' :
-   cli.paramCount > 2 ? 'Extraneous parameter: ' + cli.params[2] :
-   null;
-if (error)
-   throw new Error('[copy-folder-util] ' + error);
-const options = {
-   cd:             cli.flagMap.cd ?? null,
-   fileExtensions: cli.flagMap.ext?.split(',') ?? [],
-   };
-const results = copyFolder.cp(source, target, options);
-if (!cli.flagOn.quiet)
-   copyFolder.reporter(results, { summaryOnly: cli.flagOn.summary });
+copyFolder.cli();

package/dist/copy-folder.d.ts

@@ -1,4 +1,4 @@
-//! copy-folder-util v1.1.7 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.2.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 export type Settings = {
     basename: string | null;
@@ -24,6 +24,7 @@ declare const copyFolder: {
         folders: string[];
     };
     assert(ok: unknown, message: string | null): void;
+    cli(): void;
     cp(sourceFolder: string, targetFolder: string, options?: Partial<Settings>): Results;
     reporter(results: Results, options?: Partial<ReporterSettings>): Results;
 };

package/dist/copy-folder.js

@@ -1,5 +1,6 @@
-//! copy-folder-util v1.1.7 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.2.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
+import { cliArgvUtil } from 'cli-argv-util';
 import chalk from 'chalk';
 import fs from 'fs';
 import log from 'fancy-log';
@@ -14,6 +15,26 @@ const copyFolder = {
         if (!ok)
             throw new Error(`[copy-folder-util] ${message}`);
     },
+    cli() {
+        const validFlags = ['basename', 'cd', 'ext', 'note', 'quiet', 'summary'];
+        const cli = cliArgvUtil.parse(validFlags);
+        const source = cli.params[0];
+        const target = cli.params[1];
+        const error = cli.invalidFlag ? cli.invalidFlagMsg :
+            !source ? 'Missing source folder.' :
+                !target ? 'Missing target folder.' :
+                    cli.paramCount > 2 ? 'Extraneous parameter: ' + cli.params[2] :
+                        null;
+        copyFolder.assert(!error, error);
+        const options = {
+            basename: cli.flagMap.basename ?? null,
+            cd: cli.flagMap.cd ?? null,
+            fileExtensions: cli.flagMap.ext?.split(',') ?? [],
+        };
+        const results = copyFolder.cp(source, target, options);
+        if (!cli.flagOn.quiet)
+            copyFolder.reporter(results, { summaryOnly: cli.flagOn.summary });
+    },
     cp(sourceFolder, targetFolder, options) {
         const defaults = {
             basename: null,
@@ -74,13 +95,12 @@ const copyFolder = {
         };
         const settings = { ...defaults, ...options };
         const name = chalk.gray('copy-folder');
-        const source = chalk.blue.bold(results.source);
-        const target = chalk.magenta(results.target);
-        const arrow = { big: chalk.gray.bold(' ⟹  '), little: chalk.gray.bold('→') };
+        const indent = chalk.gray('|');
+        const ancestor = cliArgvUtil.calcAncestor(results.source, results.target);
         const infoColor = results.count ? chalk.white : chalk.red.bold;
         const info = infoColor(`(files: ${results.count}, ${results.duration}ms)`);
-        log(name, source, arrow.big, target, info);
-        const logFile = (file) => log(name, chalk.white(file.origin), arrow.little, chalk.green(file.dest));
+        log(name, ancestor.message, info);
+        const logFile = (file) => log(name, indent, cliArgvUtil.calcAncestor(file.origin, file.dest).message);
         if (!settings.summaryOnly)
             results.files.forEach(logFile);
         return results;

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "copy-folder-util",
-   "version": "1.1.7",
+   "version": "1.2.1",
    "description": "Recursively copy files from one folder to another folder (CLI tool designed for use in npm package.json scripts)",
    "license": "MIT",
    "type": "module",
@@ -58,18 +58,19 @@
    },
    "scripts": {
       "pretest": "run-scripts clean lint build",
-      "test": "mocha spec/*.spec.js"
+      "test": "mocha spec/*.spec.js",
+      "posttest": "html-validator spec"
    },
    "dependencies": {
       "chalk": "~5.6",
-      "cli-argv-util": "~1.3",
+      "cli-argv-util": "~1.4",
       "fancy-log": "~2.0",
       "slash": "~5.1"
    },
    "devDependencies": {
       "@eslint/js": "~9.39",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.10",
+      "@types/node": "~25.0",
       "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.3",
@@ -79,6 +80,7 @@
       "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
       "typescript": "~5.9",
-      "typescript-eslint": "~8.46"
+      "typescript-eslint": "~8.50",
+      "w3c-html-validator": "~2.0"
    }
 }