copy-folder-util 1.0.0 → 1.1.1

package/README.md

@@ -5,7 +5,6 @@ _Recursively copy files from one folder to another folder (CLI tool designed for
 
 [![License:MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/center-key/copy-folder-util/blob/main/LICENSE.txt)
 [![npm](https://img.shields.io/npm/v/copy-folder-util.svg)](https://www.npmjs.com/package/copy-folder-util)
-[![Vulnerabilities](https://snyk.io/test/github/center-key/copy-folder-util/badge.svg)](https://snyk.io/test/github/center-key/copy-folder-util)
 [![Build](https://github.com/center-key/copy-folder-util/workflows/build/badge.svg)](https://github.com/center-key/copy-folder-util/actions/workflows/run-spec-on-push.yaml)
 
 **copy-folder-util** takes a source folder and copies its files and subfolders to a new destination. 
@@ -36,14 +35,13 @@ Example **package.json** scripts:
    },
 ```
 
-### 2. Global
-You can install **copy-folder-util** globally and then run it anywhere directly from the terminal.
-
+### 2. Command-line npx
 Example terminal commands:
 ```shell
-$ npm install --global copy-folder-util
-$ copy-folder src/web ext=.html docs/api-manual
+$ npm install --save-dev copy-folder-util
+$ 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
 Command-line flags:
@@ -57,10 +55,17 @@ Command-line flags:
 | `--summary`  | Only print out the single line summary message.       | N/A        |
 
 Examples:
-   - `copy-folder build --basename=index dist`    Only copy files with filenames matching `index.*`.
-   - `copy-folder -cd=spec fixtures mock1`        Copy the folder **spec/fixtures** to **spec/mock1**.
-   - `copy-folder build dist --summary`           Displays the summary but not the individual files copied.
-   - `copy-folder src/web --ext=.js,.html docs`   Copy only the JavaScript and HTML files to the **docs** folder.
+   - `copy-folder build --basename=index dist` <br>
+   Only copy files with filenames matching `index.*`.
+
+   - `copy-folder -cd=spec fixtures mock1`<br>
+   Copy 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/web --ext=.js,.html docs`<br>
+   Copy only the JavaScript and HTML files to the **docs** folder.
 
 ## 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.
@@ -68,6 +73,7 @@ Even though **copy-folder-util** is primarily intended for build scripts, the pa
 Example:
 ``` typescript
 import { copyFolder } from 'copy-folder-util';
+
 const options = { fileExtensions: ['.html', '.js'] };
 const results = copyFolder.cp('src/web', 'docs/api-manual', options);
 console.log('Number of files copied:', results.count);
@@ -82,6 +88,7 @@ See the **TypeScript Declarations** at the top of [copy-folder.ts](copy-folder.t
    - 🎋 [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_
+   - 🪺 [recursive-exec](https://github.com/center-key/recursive-exec):&nbsp; _Run a command on each file in a folder and its subfolders_
    - 🔍 [replacer-util](https://github.com/center-key/replacer-util):&nbsp; _Find and replace strings or template outputs in text files_
    - 🔢 [rev-web-assets](https://github.com/center-key/rev-web-assets):&nbsp; _Revision web asset filenames with cache busting content hash fingerprints_
    - 🚆 [run-scripts-util](https://github.com/center-key/run-scripts-util):&nbsp; _Organize npm scripts into named groups of easy to manage commands_

package/bin/cli.js

@@ -10,7 +10,7 @@
 //    },
 //
 // Usage from command line:
-//    $ npm install --global copy-folder-util
+//    $ npm install --save-dev copy-folder-util
 //    $ copy-folder build dist
 //    $ copy-folder src/web --ext=.js,.html docs
 //

package/dist/copy-folder.d.ts

@@ -1,4 +1,4 @@
-//! copy-folder-util v1.0.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.1.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 export type Settings = {
     basename: string;

package/dist/copy-folder.js

@@ -1,4 +1,4 @@
-//! copy-folder-util v1.0.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v1.1.1 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 import fs from 'fs';
 import path from 'path';
@@ -12,7 +12,7 @@ const copyFolder = {
             cd: null,
             fileExtensions: [],
         };
-        const settings = Object.assign(Object.assign({}, defaults), options);
+        const settings = { ...defaults, ...options };
         const startTime = Date.now();
         const normalize = (folder) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, '');
         const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';

package/package.json

@@ -1,19 +1,18 @@
 {
    "name": "copy-folder-util",
-   "version": "1.0.0",
+   "version": "1.1.1",
    "description": "Recursively copy files from one folder to another folder (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
    "module": "dist/copy-folder.js",
-   "main": "dist/copy-folder.umd.cjs",
+   "main": "dist/copy-folder.js",
    "types": "dist/copy-folder.d.ts",
    "files": [
       "dist"
    ],
    "exports": {
       ".": {
-         "import": "./dist/copy-folder.js",
-         "require": "./dist/copy-folder.umd.cjs"
+         "import": "./dist/copy-folder.js"
       },
       "./": "./dist/"
    },
@@ -67,40 +66,41 @@
       }
    },
    "runScriptsConfig": {
-      "build": [
-         "rimraf build dist spec/fixtures/target **/.DS_Store",
+      "clean": [
+         "rimraf build dist spec/fixtures/target"
+      ],
+      "lint": [
          "jshint . --exclude-path .gitignore",
-         "eslint --max-warnings 0 . --ext .ts",
+         "eslint --max-warnings 0 . --ext .ts"
+      ],
+      "build": [
          "tsc",
-         "tsc --module UMD --outDir build/umd",
-         "copy-file build/umd/copy-folder.js build/copy-folder.umd.cjs",
          "add-dist-header build dist"
       ]
    },
    "scripts": {
-      "pretest": "run-scripts build",
+      "pretest": "run-scripts clean lint build",
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
-      "chalk": "~5.2",
-      "cli-argv-util": "~1.0",
+      "chalk": "~5.3",
+      "cli-argv-util": "~1.2",
       "fancy-log": "~2.0",
-      "slash": "~5.0"
+      "slash": "~5.1"
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/node": "~18.14",
-      "@typescript-eslint/eslint-plugin": "~5.52",
-      "@typescript-eslint/parser": "~5.52",
-      "add-dist-header": "~1.0",
-      "assert-deep-strict-equal": "~1.0",
-      "copy-file-util": "~1.0",
-      "eslint": "~8.34",
+      "@types/node": "~20.5",
+      "@typescript-eslint/eslint-plugin": "~6.4",
+      "@typescript-eslint/parser": "~6.4",
+      "add-dist-header": "~1.2",
+      "assert-deep-strict-equal": "~1.1",
+      "copy-file-util": "~1.1",
+      "eslint": "~8.47",
       "jshint": "~2.13",
       "mocha": "~10.2",
-      "rev-web-assets": "~0.1",
-      "rimraf": "3",
-      "run-scripts-util": "~0.1",
-      "typescript": "~4.9"
+      "rimraf": "~5.0",
+      "run-scripts-util": "~1.2",
+      "typescript": "~5.1"
    }
 }

package/dist/copy-folder.umd.cjs

@@ -1,81 +0,0 @@
-//! copy-folder-util v1.0.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-(function (factory) {
-    if (typeof module === "object" && typeof module.exports === "object") {
-        var v = factory(require, exports);
-        if (v !== undefined) module.exports = v;
-    }
-    else if (typeof define === "function" && define.amd) {
-        define(["require", "exports", "fs", "path", "slash"], factory);
-    }
-})(function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.copyFolder = void 0;
-    const fs_1 = __importDefault(require("fs"));
-    const path_1 = __importDefault(require("path"));
-    const slash_1 = __importDefault(require("slash"));
-    const extraneousFiles = ['.DS_Store', 'Thumbs.db', 'desktop.ini'];
-    const extraneousFolders = ['.git', 'node_modules'];
-    const copyFolder = {
-        cp(sourceFolder, targetFolder, options) {
-            const defaults = {
-                basename: null,
-                cd: null,
-                fileExtensions: [],
-            };
-            const settings = Object.assign(Object.assign({}, defaults), options);
-            const startTime = Date.now();
-            const normalize = (folder) => !folder ? '' : (0, slash_1.default)(path_1.default.normalize(folder)).replace(/\/$/, '');
-            const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';
-            const source = normalize(startFolder + sourceFolder);
-            const target = normalize(startFolder + targetFolder);
-            if (targetFolder)
-                fs_1.default.mkdirSync(target, { recursive: true });
-            const errorMessage = !sourceFolder ? 'Must specify the source folder path.' :
-                !targetFolder ? 'Must specify the target folder path.' :
-                    !fs_1.default.existsSync(source) ? 'Source folder does not exist: ' + source :
-                        !fs_1.default.existsSync(target) ? 'Target folder cannot be created: ' + target :
-                            !fs_1.default.statSync(source).isDirectory() ? 'Source is not a folder: ' + source :
-                                !fs_1.default.statSync(target).isDirectory() ? 'Target is not a folder: ' + target :
-                                    null;
-            if (errorMessage)
-                throw Error('[copy-folder-util] ' + errorMessage);
-            const filterOff = {
-                base: !settings.basename,
-                ext: !settings.fileExtensions || settings.fileExtensions.length === 0,
-            };
-            const files = [];
-            const posixPath = (nativePath) => (0, slash_1.default)(nativePath.replace(/.*:/, ''));
-            const relativePath = (fullPath, start) => fullPath.substring(fullPath.indexOf(start) + start.length + 1);
-            const filter = (origin, dest) => {
-                const isFile = fs_1.default.statSync(origin).isFile();
-                const name = path_1.default.basename(origin);
-                const ext = path_1.default.extname(origin);
-                const keepFolder = !isFile && !extraneousFolders.includes(name);
-                const keepFile = isFile &&
-                    (filterOff.base || name.replace(/[.].*/, '') === settings.basename) &&
-                    (filterOff.ext || settings.fileExtensions.includes(ext)) &&
-                    !extraneousFiles.includes(name);
-                if (keepFile)
-                    files.push({
-                        origin: relativePath(posixPath(origin), source),
-                        dest: relativePath(posixPath(dest), target),
-                    });
-                return keepFolder || keepFile;
-            };
-            fs_1.default.cpSync(source, target, { filter: filter, recursive: true });
-            return {
-                source: source,
-                target: target,
-                count: files.length,
-                duration: Date.now() - startTime,
-                files: files,
-            };
-        },
-    };
-    exports.copyFolder = copyFolder;
-});