copy-folder-util 0.2.0 → 0.2.2

package/README.md

@@ -1,7 +1,7 @@
 # copy-folder-util
 <img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
 
-_Recursively copy a folder (CLI tool designed for use in npm scripts)_
+_Recursively copy files from one folder to another folder (CLI tool designed for use in npm scripts)_
 
 [![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)
@@ -35,7 +35,6 @@ Example **package.json** scripts:
       "make-docs": "copy-folder src/web --ext=.html docs/api-manual"
    },
 ```
-Try out the first script with the command: `npm run make-dist`
 
 ### 2. Global
 You can install **copy-folder-util** globally and then run it anywhere directly from the terminal.
@@ -53,6 +52,7 @@ Command-line flags:
 | `--basename` | Filter files by filename ignoring the file extension. | **string** |
 | `--cd`       | Change working directory before starting copy.        | **string** |
 | `--ext`      | Filter files by file extension, such as `.js`.<br>Use a comma to specify multiple extensions. | **string** |
+| `--note`     | Place to add a comment only for humans.               | **string** |
 | `--quiet`    | Suppress informational messages.                      | N/A        |
 | `--summary`  | Only print out the single line summary message.       | N/A        |
 
@@ -80,10 +80,11 @@ See the **TypeScript Declarations** at the top of [copy-folder.ts](copy-folder.t
 ---
 **CLI Build Tools**
    - 🎋 [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_
-   - 📂 [copy-folder-util](https://github.com/center-key/copy-folder-util):&nbsp; _Recursively copy the files in a folder_
+   - 📄 [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_
    - 🔍 [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_
    - 🚦 [w3c-html-validator](https://github.com/center-key/w3c-html-validator):&nbsp; _Check the markup validity of HTML files using the W3C validator_
 
 Feel free to submit questions at:<br>

package/bin/cli.js

@@ -26,7 +26,7 @@ import chalk from 'chalk';
 import log   from 'fancy-log';
 
 // Parameters
-const validFlags =  ['cd', 'ext', 'quiet', 'summary'];
+const validFlags =  ['cd', 'ext', 'note', 'quiet', 'summary'];
 const args =        process.argv.slice(2);
 const flags =       args.filter(arg => /^--/.test(arg));
 const flagMap =     Object.fromEntries(flags.map(flag => flag.replace(/^--/, '').split('=')));

package/dist/copy-folder.d.ts

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

package/dist/copy-folder.js

@@ -1,4 +1,4 @@
-//! copy-folder-util v0.2.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v0.2.2 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 import fs from 'fs';
 import path from 'path';
@@ -34,6 +34,8 @@ const copyFolder = {
             ext: !settings.fileExtensions || settings.fileExtensions.length === 0,
         };
         const files = [];
+        const posixPath = (nativePath) => slash(nativePath.replace(/.*:/, ''));
+        const relativePath = (fullPath, start) => fullPath.substring(fullPath.indexOf(start) + start.length + 1);
         const filter = (origin, dest) => {
             const isFile = fs.statSync(origin).isFile();
             const name = path.basename(origin);
@@ -45,8 +47,8 @@ const copyFolder = {
                 !extraneousFiles.includes(name);
             if (keepFile)
                 files.push({
-                    origin: origin.substring(source.length + 1),
-                    dest: dest.substring(target.length + 1),
+                    origin: relativePath(posixPath(origin), source),
+                    dest: relativePath(posixPath(dest), target),
                 });
             return keepFolder || keepFile;
         };

package/dist/copy-folder.umd.cjs

@@ -1,4 +1,4 @@
-//! copy-folder-util v0.2.0 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
+//! copy-folder-util v0.2.2 ~~ https://github.com/center-key/copy-folder-util ~~ MIT License
 
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -49,6 +49,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                 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);
@@ -60,8 +62,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
                     !extraneousFiles.includes(name);
                 if (keepFile)
                     files.push({
-                        origin: origin.substring(source.length + 1),
-                        dest: dest.substring(target.length + 1),
+                        origin: relativePath(posixPath(origin), source),
+                        dest: relativePath(posixPath(dest), target),
                     });
                 return keepFolder || keepFile;
             };

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "copy-folder-util",
-   "version": "0.2.0",
-   "description": "Recursively copy a folder (CLI tool designed for use in npm scripts)",
+   "version": "0.2.2",
+   "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",
@@ -66,15 +66,19 @@
          "@typescript-eslint/no-non-null-assertion": "off"
       }
    },
+   "runScriptsConfig": {
+      "build": [
+         "rimraf build dist spec/fixtures/target **/.DS_Store",
+         "jshint . --exclude-path .gitignore",
+         "eslint --max-warnings 0 . --ext .ts",
+         "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": {
-      "step:01": "rimraf build dist spec/fixtures/target **/.DS_Store",
-      "step:02": "jshint . --exclude-path .gitignore",
-      "step:03": "eslint --max-warnings 0 . --ext .ts",
-      "step:04": "tsc",
-      "step:05": "tsc --module UMD --outDir build/umd",
-      "step:06": "copy-file build/umd/copy-folder.js build/copy-folder.umd.cjs",
-      "step:07": "add-dist-header build dist",
-      "pretest": "npm-run-all step:*",
+      "pretest": "run-scripts build",
       "test": "mocha spec/*.spec.js"
    },
    "dependencies": {
@@ -84,18 +88,18 @@
    },
    "devDependencies": {
       "@types/fancy-log": "~2.0",
-      "@types/node": "~18.8",
-      "@typescript-eslint/eslint-plugin": "~5.40",
-      "@typescript-eslint/parser": "~5.40",
+      "@types/node": "~18.11",
+      "@typescript-eslint/eslint-plugin": "~5.42",
+      "@typescript-eslint/parser": "~5.42",
       "add-dist-header": "~0.3",
       "assert-deep-strict-equal": "~1.0",
       "copy-file-util": "~0.1",
-      "eslint": "~8.25",
+      "eslint": "~8.27",
       "jshint": "~2.13",
-      "mocha": "~10.0",
-      "npm-run-all2": "~6.0",
+      "mocha": "~10.1",
       "rev-web-assets": "~0.1",
       "rimraf": "~3.0",
+      "run-scripts-util": "~0.1",
       "typescript": "~4.8"
    }
 }