copy-file-util 0.0.2 → 0.1.0

package/README.md

@@ -1,7 +1,7 @@
 # copy-file-util
 <img src=https://centerkey.com/graphics/center-key-logo.svg align=right width=200 alt=logo>
 
-_A file copy and rename cli tool designed for use in npm scripts_
+_Copy or rename a file (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-file-util/blob/main/LICENSE.txt)
 [![npm](https://img.shields.io/npm/v/copy-file-util.svg)](https://www.npmjs.com/package/copy-file-util)
@@ -70,8 +70,12 @@ See the **TypeScript Declaration File** file [copy-file.d.ts](dist/copy-file.d.t
 
 ---
 **Build Tools**
-   - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Adds a header comment to a file and saves it to your distribution folder_
-   - 📄 [copy-file-util](https://github.com/center-key/copy-file-util):&nbsp; _A file copy and rename cli tool designed for use in npm scripts_
-   - 📂 [copy-folder-cli](https://github.com/center-key/copy-folder-cli):&nbsp; _A recursive directory file copy utility designed for use in npm scripts_
+   - 🎋 [add-dist-header](https://github.com/center-key/add-dist-header):&nbsp; _Prepend a one-line header comment (with license notice) to distribution files_
+   - 📄 [copy-file-util](https://github.com/center-key/copy-file-util):&nbsp; _Copy or rename a file (CLI tool designed for use in npm scripts)_
+   - 📂 [copy-folder-cli](https://github.com/center-key/copy-folder-cli):&nbsp; _Recursively copy a folder (CLI tool designed for use in npm scripts)_
+   - 🚦 [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>
+[github.com/center-key/copy-file-util/issues](https://github.com/center-key/copy-file-util/issues)
 
 [MIT License](LICENSE.txt)

package/bin/cli.js

@@ -17,7 +17,7 @@
 //    $ cd copy-file-util
 //    $ npm install
 //    $ npm test
-//    $ node bin/cli.js spec/fixtures/source/mock.txt --folder spec/fixtures/target/to-folder
+//    $ node bin/cli.js --cd=spec/fixtures source/mock.txt --folder target/to-folder
 
 // Imports
 import { copyFile } from '../dist/copy-file.js';
@@ -25,7 +25,7 @@ import chalk        from 'chalk';
 import log          from 'fancy-log';
 
 // Parameters
-const validFlags = ['folder', 'quiet'];
+const validFlags = ['cd', 'folder', 'quiet'];
 const args =       process.argv.slice(2);
 const flags =      args.filter(arg => /^--/.test(arg));
 const flagMap =    Object.fromEntries(flags.map(flag => flag.replace(/^--/, '').split('=')));
@@ -44,7 +44,6 @@ const printReport = (result) => {
    };
 
 // Copy File
-const exit =        (message) => (console.error('[copy-file]', message), process.exit(1));
 const invalidFlag = Object.keys(flagMap).find(key => !validFlags.includes(key));
 const mode =        { folder: 'folder' in flagMap, quiet: 'quiet' in flagMap };
 const error =
@@ -55,8 +54,12 @@ const error =
    !target ?                'Missing target file.' :
    null;
 if (error)
-   exit(error);
-const options = mode.folder ? { targetFolder: target } : { targetFile: target };
+   throw Error('[copy-file] ' + error);
+const targetKey = mode.folder ? 'targetFolder' : 'targetFile';
+const options = {
+   cd:          flagMap.cd ?? null,
+   [targetKey]: target,
+   };
 const result = copyFile.cp(source, options);
 if (!mode.quiet)
    printReport(result);

package/dist/copy-file.d.ts

@@ -1,6 +1,7 @@
-//! copy-file-util v0.0.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 export declare type Options = {
+    cd?: string;
     targetFile?: string;
     targetFolder?: string;
     fileExtension?: string;

package/dist/copy-file.js

@@ -1,4 +1,4 @@
-//! copy-file-util v0.0.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 import fs from 'fs-extra';
 import path from 'path';
@@ -7,6 +7,7 @@ const copyFile = {
     cp(sourceFile, options) {
         var _a;
         const defaults = {
+            cd: null,
             targetFile: null,
             targetFolder: null,
             fileExtension: null,
@@ -16,11 +17,14 @@ const copyFile = {
         const missingTarget = !settings.targetFile && !settings.targetFolder;
         const ambiguousTarget = !!settings.targetFile && !!settings.targetFolder;
         const normalize = (folder) => !folder ? '' : slash(path.normalize(folder)).replace(/\/$/, '');
-        const source = normalize(sourceFile);
+        const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';
+        const source = normalize(startFolder + sourceFile);
         const sourceExists = fs.pathExistsSync(source);
         const sourceIsFile = sourceExists && fs.statSync(source).isFile();
-        const targetFolder = normalize(settings.targetFile ? path.dirname(settings.targetFile) : settings.targetFolder);
-        const target = normalize((_a = settings.targetFile) !== null && _a !== void 0 ? _a : settings.targetFolder + '/' + path.basename(source));
+        const targetPath = settings.targetFile ? path.dirname(settings.targetFile) : settings.targetFolder;
+        const targetFolder = normalize(startFolder + targetPath);
+        const targetFile = (_a = settings.targetFile) !== null && _a !== void 0 ? _a : settings.targetFolder + '/' + path.basename(source);
+        const target = normalize(startFolder + targetFile);
         if (targetFolder)
             fs.ensureDirSync(targetFolder);
         const badTargetFolder = !fs.pathExistsSync(targetFolder);

package/dist/copy-file.umd.cjs

@@ -1,4 +1,4 @@
-//! copy-file-util v0.0.2 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
+//! copy-file-util v0.1.0 ~~ https://github.com/center-key/copy-file-util ~~ MIT License
 
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
@@ -22,6 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
         cp(sourceFile, options) {
             var _a;
             const defaults = {
+                cd: null,
                 targetFile: null,
                 targetFolder: null,
                 fileExtension: null,
@@ -31,11 +32,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
             const missingTarget = !settings.targetFile && !settings.targetFolder;
             const ambiguousTarget = !!settings.targetFile && !!settings.targetFolder;
             const normalize = (folder) => !folder ? '' : (0, slash_1.default)(path_1.default.normalize(folder)).replace(/\/$/, '');
-            const source = normalize(sourceFile);
+            const startFolder = settings.cd ? normalize(settings.cd) + '/' : '';
+            const source = normalize(startFolder + sourceFile);
             const sourceExists = fs_extra_1.default.pathExistsSync(source);
             const sourceIsFile = sourceExists && fs_extra_1.default.statSync(source).isFile();
-            const targetFolder = normalize(settings.targetFile ? path_1.default.dirname(settings.targetFile) : settings.targetFolder);
-            const target = normalize((_a = settings.targetFile) !== null && _a !== void 0 ? _a : settings.targetFolder + '/' + path_1.default.basename(source));
+            const targetPath = settings.targetFile ? path_1.default.dirname(settings.targetFile) : settings.targetFolder;
+            const targetFolder = normalize(startFolder + targetPath);
+            const targetFile = (_a = settings.targetFile) !== null && _a !== void 0 ? _a : settings.targetFolder + '/' + path_1.default.basename(source);
+            const target = normalize(startFolder + targetFile);
             if (targetFolder)
                 fs_extra_1.default.ensureDirSync(targetFolder);
             const badTargetFolder = !fs_extra_1.default.pathExistsSync(targetFolder);

package/package.json

@@ -1,7 +1,7 @@
 {
    "name": "copy-file-util",
-   "version": "0.0.2",
-   "description": "A file copy and rename cli tool designed for use in npm scripts (written in functional TypeScript)",
+   "version": "0.1.0",
+   "description": "Copy or rename a file (CLI tool designed for use in npm scripts)",
    "license": "MIT",
    "type": "module",
    "module": "dist/copy-file.js",
@@ -69,8 +69,7 @@
       "step:04": "tsc",
       "step:05": "tsc --module UMD --outDir build/umd",
       "step:06": "cpy build/umd/copy-file.js build --rename=copy-file.umd.cjs --flat=true",
-      "step:07": "cpy build/copy-file.* dist --flat=true",
-      "step:08": "add-dist-header build dist",
+      "step:07": "add-dist-header build dist",
       "pretest": "npm-run-all step:*",
       "test": "mocha spec/*.spec.js"
    },