copy-folder-util 1.1.1 → 1.1.3

package/LICENSE.txt

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

@@ -56,19 +56,24 @@ Command-line flags:
 
 Examples:
    - `copy-folder build --basename=index dist` <br>
-   Only copy files with filenames matching `index.*`.
+   Only copies files with filenames matching `index.*`.
 
    - `copy-folder -cd=spec fixtures mock1`<br>
-   Copy the folder **spec/fixtures** to **spec/mock1**.
+   Copies the folder **spec/fixtures** to **spec/mock1**.
 
    - `copy-folder build dist --summary`<br>
    Displays the summary but not the individual files copied.
 
+   - `copy-folder 'src/Legal Notices' dist --summary`<br>
+   Copies a folder that has a space in its name.
+
    - `copy-folder src/web --ext=.js,.html docs`<br>
-   Copy only the JavaScript and HTML files to the **docs** folder.
+   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._
 
 ## C) Application Code
-Even though **copy-folder-util** is primarily intended for build scripts, the package can easily be used programmatically in ESM and TypeScript projects.
+Even though **copy-folder-util** is primarily intended for build scripts, the package can be used programmatically in ESM and TypeScript projects.
 
 Example:
 ``` typescript
@@ -84,7 +89,7 @@ See the **TypeScript Declarations** at the top of [copy-folder.ts](copy-folder.t
 <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

@@ -23,8 +23,6 @@
 // Imports
 import { cliArgvUtil } from 'cli-argv-util';
 import { copyFolder } from '../dist/copy-folder.js';
-import chalk from 'chalk';
-import log   from 'fancy-log';
 
 // Parameters and flags
 const validFlags = ['cd', 'ext', 'note', 'quiet', 'summary'];
@@ -32,20 +30,6 @@ const cli =        cliArgvUtil.parse(validFlags);
 const source =     cli.params[0];
 const target =     cli.params[1];
 
-// Reporting
-const printReport = (results) => {
-   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 infoColor = results.count ? chalk.white : chalk.red.bold;
-   const info =      infoColor(`(files: ${results.count}, ${results.duration}ms)`);
-   const logFile =   (file) => log(name, chalk.white(file.origin), arrow.little, chalk.green(file.dest));
-   log(name, source, arrow.big, target, info);
-   if (!cli.flagOn.summary)
-      results.files.forEach(logFile);
-   };
-
 // Copy Folder
 const error =
    cli.invalidFlag ?     cli.invalidFlagMsg :
@@ -61,4 +45,4 @@ const options = {
    };
 const results = copyFolder.cp(source, target, options);
 if (!cli.flagOn.quiet)
-   printReport(results);
+   copyFolder.reporter(results, { summaryOnly: cli.flagOn.summary });

package/dist/copy-folder.d.ts

@@ -1,11 +1,10 @@
-//! copy-folder-util v1.1.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.1.3 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 export type Settings = {
     basename: string;
     cd: string;
     fileExtensions: string[];
 };
-export type Options = Partial<Settings>;
 export type Results = {
     source: string;
     target: string;
@@ -16,7 +15,11 @@ export type Results = {
         dest: string;
     }[];
 };
+export type ReporterSettings = {
+    summaryOnly: boolean;
+};
 declare const copyFolder: {
-    cp(sourceFolder: string, targetFolder: string, options?: Options): Results;
+    cp(sourceFolder: string, targetFolder: string, options?: Partial<Settings>): Results;
+    reporter(results: Results, options?: Partial<ReporterSettings>): Results;
 };
 export { copyFolder };

package/dist/copy-folder.js

@@ -1,6 +1,8 @@
-//! copy-folder-util v1.1.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.1.3 ~~ https://github.com/center-key/copy-folder-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 extraneousFiles = ['.DS_Store', 'Thumbs.db', 'desktop.ini'];
@@ -61,5 +63,22 @@ const copyFolder = {
             files: files,
         };
     },
+    reporter(results, options) {
+        const defaults = {
+            summaryOnly: false,
+        };
+        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 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));
+        if (!settings.summaryOnly)
+            results.files.forEach(logFile);
+        return results;
+    },
 };
 export { copyFolder };

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "copy-folder-util",
-   "version": "1.1.1",
+   "version": "1.1.3",
    "description": "Recursively copy files from one folder to another folder (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
@@ -20,7 +20,10 @@
       "copy-folder": "bin/cli.js",
       "copy-folder-util": "bin/cli.js"
    },
-   "repository": "github:center-key/copy-folder-util",
+   "repository": {
+      "type": "git",
+      "url": "git+https://github.com/center-key/copy-folder-util.git"
+   },
    "homepage": "https://github.com/center-key/copy-folder-util",
    "bugs": "https://github.com/center-key/copy-folder-util/issues",
    "docs": "https://github.com/center-key/copy-folder-util#readme",
@@ -90,17 +93,17 @@
    },
    "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",
       "copy-file-util": "~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"
    }
 }