copy-folder-util 1.1.6 → 1.2.0

package/README.md

@@ -54,7 +54,7 @@ Command-line flags:
 | `--quiet`    | Suppress informational messages.                      | N/A        |
 | `--summary`  | Only print out the single line summary message.       | N/A        |
 
-Examples:
+### 4. Examples
    - `copy-folder build --basename=index dist` <br>
    Only copies files with filenames matching `index.*`.
 

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,8 +1,8 @@
-//! copy-folder-util v1.1.6 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.2.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 export type Settings = {
-    basename: string;
-    cd: string;
+    basename: string | null;
+    cd: string | null;
     fileExtensions: string[];
 };
 export type Results = {
@@ -19,6 +19,12 @@ export type ReporterSettings = {
     summaryOnly: boolean;
 };
 declare const copyFolder: {
+    extraneous: {
+        files: string[];
+        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,13 +1,40 @@
-//! copy-folder-util v1.1.6 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.2.0 ~~ 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';
 import path from 'path';
 import slash from 'slash';
-const extraneousFiles = ['.DS_Store', 'Thumbs.db', 'desktop.ini'];
-const extraneousFolders = ['.git', 'node_modules'];
 const copyFolder = {
+    extraneous: {
+        files: ['.DS_Store', 'Thumbs.db', 'desktop.ini'],
+        folders: ['.git', 'node_modules'],
+    },
+    assert(ok, message) {
+        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,
@@ -16,21 +43,20 @@ const copyFolder = {
         };
         const settings = { ...defaults, ...options };
         const startTime = Date.now();
-        const normalize = (folder) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, '');
-        const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';
-        const source = normalize(startFolder + sourceFolder);
-        const target = normalize(startFolder + targetFolder);
+        const cleanPath = (folder) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, '');
+        const startFolder = settings.cd ? cleanPath(settings.cd) + '/' : '';
+        const source = cleanPath(startFolder + sourceFolder);
+        const target = cleanPath(startFolder + targetFolder);
         if (targetFolder)
             fs.mkdirSync(target, { recursive: true });
-        const errorMessage = !sourceFolder ? 'Must specify the source folder path.' :
+        const error = !sourceFolder ? 'Must specify the source folder path.' :
             !targetFolder ? 'Must specify the target folder path.' :
                 !fs.existsSync(source) ? 'Source folder does not exist: ' + source :
                     !fs.existsSync(target) ? 'Target folder cannot be created: ' + target :
                         !fs.statSync(source).isDirectory() ? 'Source is not a folder: ' + source :
                             !fs.statSync(target).isDirectory() ? 'Target is not a folder: ' + target :
                                 null;
-        if (errorMessage)
-            throw new Error('[copy-folder-util] ' + errorMessage);
+        copyFolder.assert(!error, error);
         const filterOff = {
             base: !settings.basename,
             ext: !Array.isArray(settings.fileExtensions) || !settings.fileExtensions.length,
@@ -42,11 +68,11 @@ const copyFolder = {
             const isFile = fs.statSync(origin).isFile();
             const name = path.basename(origin);
             const ext = path.extname(origin);
-            const keepFolder = !isFile && !extraneousFolders.includes(name);
+            const keepFolder = !isFile && !copyFolder.extraneous.folders.includes(name);
             const keepFile = isFile &&
                 (filterOff.base || name.replace(/[.].*/, '') === settings.basename) &&
                 (filterOff.ext || settings.fileExtensions.includes(ext)) &&
-                !extraneousFiles.includes(name);
+                !copyFolder.extraneous.files.includes(name);
             if (keepFile)
                 files.push({
                     origin: relativePath(posixPath(origin), source),

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "copy-folder-util",
-   "version": "1.1.6",
+   "version": "1.2.0",
    "description": "Recursively copy files from one folder to another folder (CLI tool designed for use in npm package.json scripts)",
    "license": "MIT",
    "type": "module",
@@ -45,7 +45,7 @@
    },
    "runScriptsConfig": {
       "clean": [
-         "rimraf build dist spec/fixtures/target"
+         "rimraf build dist spec/target"
       ],
       "lint": [
          "jshint . --exclude-path .gitignore",
@@ -67,18 +67,18 @@
       "slash": "~5.1"
    },
    "devDependencies": {
-      "@eslint/js": "~9.36",
+      "@eslint/js": "~9.39",
       "@types/fancy-log": "~2.0",
-      "@types/node": "~24.5",
-      "add-dist-header": "~1.5",
+      "@types/node": "~24.10",
+      "add-dist-header": "~1.6",
       "assert-deep-strict-equal": "~1.2",
       "copy-file-util": "~1.3",
-      "eslint": "~9.36",
+      "eslint": "~9.39",
       "jshint": "~2.13",
       "mocha": "~11.7",
-      "rimraf": "~6.0",
+      "rimraf": "~6.1",
       "run-scripts-util": "~1.3",
       "typescript": "~5.9",
-      "typescript-eslint": "~8.44"
+      "typescript-eslint": "~8.46"
    }
 }