@dynamicweb/cli 1.0.15 → 1.1.0

package/bin/index.js

@@ -1,61 +1,73 @@
-#! /usr/bin/env node
-
-import yargs from 'yargs/yargs';
-import { hideBin } from 'yargs/helpers';
-import { loginCommand } from './commands/login.js';
-import { envCommand } from './commands/env.js';
-import { configCommand, setupConfig, getConfig } from './commands/config.js';
-import { installCommand } from './commands/install.js';
-import { filesCommand } from './commands/files.js';
-import { swiftCommand } from './commands/swift.js';
-import { databaseCommand } from './commands/database.js';
-import { queryCommand } from './commands/query.js';
-import { commandCommand } from './commands/command.js';
-
-setupConfig();
-
-yargs(hideBin(process.argv))
-    .scriptName('dw')
-    .command(baseCommand())
-    .command(loginCommand())
-    .command(envCommand())
-    .command(installCommand())
-    .command(configCommand())
-    .command(filesCommand())
-    .command(swiftCommand())
-    .command(databaseCommand())
-    .command(queryCommand())
-    .command(commandCommand())
-    .option('verbose', {
-        alias: 'v',
-        type: 'boolean',
-        description: 'Run with verbose logging'
-    })
-    .option('protocol', {
-        description: 'Allows setting the protocol used, only used together with --host, defaulting to https'
-    })
-    .option('host', {
-        description: 'Allows setting the host used, only allowed if an --apiKey is specified'
-    })
-    .option('apiKey', {
-        description: 'Allows setting the apiKey for an environmentless execution of the CLI command'
-    })
-    .demandCommand()
-    .parse()
-
-function baseCommand() {
-    return {
-        command: '$0',
-        describe: 'Shows the current env and user being used',
-        handler: () => {
-            if (Object.keys(getConfig()).length === 0) {
-                console.log('To login to a solution use `dw login`')
-                return;
-            } 
-            console.log(`Environment: ${getConfig()?.current?.env}`)
-            console.log(`User: ${getConfig()?.env[getConfig()?.current?.env]?.current?.user}`)
-            console.log(`Protocol: ${getConfig()?.env[getConfig()?.current?.env]?.protocol}`)
-            console.log(`Host: ${getConfig()?.env[getConfig()?.current?.env]?.host}`)
-        }
-    }
-}
+#! /usr/bin/env node
+
+import yargs from 'yargs/yargs';
+import { hideBin } from 'yargs/helpers';
+import { loginCommand } from './commands/login.js';
+import { envCommand } from './commands/env.js';
+import { configCommand, setupConfig, getConfig } from './commands/config.js';
+import { installCommand } from './commands/install.js';
+import { filesCommand } from './commands/files.js';
+import { swiftCommand } from './commands/swift.js';
+import { databaseCommand } from './commands/database.js';
+import { queryCommand } from './commands/query.js';
+import { commandCommand } from './commands/command.js';
+
+setupConfig();
+showGitBashRelativePathWarning();
+
+yargs(hideBin(process.argv))
+    .scriptName('dw')
+    .command(baseCommand())
+    .command(loginCommand())
+    .command(envCommand())
+    .command(installCommand())
+    .command(configCommand())
+    .command(filesCommand())
+    .command(swiftCommand())
+    .command(databaseCommand())
+    .command(queryCommand())
+    .command(commandCommand())
+    .option('verbose', {
+        alias: 'v',
+        type: 'boolean',
+        description: 'Run with verbose logging'
+    })
+    .option('protocol', {
+        description: 'Allows setting the protocol used, only used together with --host, defaulting to https'
+    })
+    .option('host', {
+        description: 'Allows setting the host used, only allowed if an --apiKey is specified'
+    })
+    .option('apiKey', {
+        description: 'Allows setting the apiKey for an environmentless execution of the CLI command'
+    })
+    .demandCommand()
+    .parse()
+
+function baseCommand() {
+    return {
+        command: '$0',
+        describe: 'Shows the current env and user being used',
+        handler: () => {
+            if (Object.keys(getConfig()).length === 0) {
+                console.log('To login to a solution use `dw login`')
+                return;
+            } 
+            console.log(`Environment: ${getConfig()?.current?.env}`)
+            console.log(`User: ${getConfig()?.env[getConfig()?.current?.env]?.current?.user}`)
+            console.log(`Protocol: ${getConfig()?.env[getConfig()?.current?.env]?.protocol}`)
+            console.log(`Host: ${getConfig()?.env[getConfig()?.current?.env]?.host}`)
+        }
+    }
+}
+
+function showGitBashRelativePathWarning() {
+    const isGitBash = !!process.env.MSYSTEM;
+    const pathConversionDisabled = process.env.MSYS_NO_PATHCONV === '1';
+
+    if (isGitBash && !pathConversionDisabled) {
+        console.warn('You appear to have path conversion turned on in your shell.');
+        console.warn('If you are using relative paths, this may interfere.');
+        console.warn('Please see https://doc.dynamicweb.dev/documentation/fundamentals/code/CLI.html for more information.');
+    }
+}

package/bin/utils.js

@@ -1,125 +1,112 @@
-import yargsInteractive from 'yargs-interactive';
-import logUpdate from 'log-update';
-
-const WRITE_THROTTLE_MS = 500;
-
-export async function interactiveConfirm(question, func) {
-    await yargsInteractive()
-        .interactive({
-            confirm: {
-                type: 'confirm',
-                default: true,
-                describe: question,
-                prompt: 'always'
-            },
-            interactive: {
-                default: true
-            }
-        })
-        .then(async (result) => {
-            if (!result.confirm) return;
-            func()
-        });
-}
-
-/**
- * Creates a throttled status updater that periodically logs status messages and elapsed time.
- *
- * The updater allows you to update the displayed status message at any time, but throttles the actual log updates
- * to the specified interval. When called with no message, the updater stops and finalizes the log output.
- *
- * @param {number} [intervalMs=WRITE_THROTTLE_MS] - The interval in milliseconds at which to update the log output.
- * @returns {{
- *   update: (message?: string) => void,
- *   stop: () => void
- * }} An object with `update` and `stop` methods:
- *   - `update(message)`: Updates the status message and starts the updater if not already running. If called with no message, stops the updater.
- *   - `stop()`: Stops the updater and finalizes the log output.
- *
- * @example
- * const updater = createThrottledStatusUpdater(500);
- * updater.update('Processing...');
- * // ... later
- * updater.update('Still working...');
- * // ... when done
- * updater.update(); // or updater.stop();
- */
-export function createThrottledStatusUpdater(intervalMs = WRITE_THROTTLE_MS) {
-    let latestMessage;
-    let timer = null;
-    let stopped = false;
-    let startTime;
-
-    function write() {
-        const elapsed = `Elapsed:\t${formatElapsed(Date.now() - startTime)}`;
-        const lines = latestMessage ? [latestMessage, elapsed] : [elapsed];
-        logUpdate(lines.join('\n'));
-    }
-
-    function start() {
-        if (timer) return;
-
-        startTime = Date.now();
-
-        timer = setInterval(() => {
-            if (stopped) return;
-            write();
-        }, intervalMs);
-    }
-
-    function stop() {
-        stopped = true;
-        if (timer) clearInterval(timer);
-        write();
-        logUpdate.done();
-    }
-
-    // The updater function you call from anywhere
-    function update(message) {
-        if (!message) {
-            stop();
-            return;
-        }
-        latestMessage = message;
-        start();
-    }
-
-    return {
-        update,
-        stop
-    };
-}
-
-/**
- * Converts a number of bytes into a human-readable string with appropriate units.
- *
- * @param {number} bytes - The number of bytes to format.
- * @returns {string} The formatted string representing the size in appropriate units (Bytes, KB, MB, GB, TB, PB).
- */
-export function formatBytes(bytes) {
-    if (bytes === 0) return '0 Bytes';
-    const k = 1024;
-    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB'];
-    const i = Math.floor(Math.log(bytes) / Math.log(k));
-    return (bytes / Math.pow(k, i)).toFixed(2) + ' ' + sizes[i];
-}
-
-/**
- * Formats a duration given in milliseconds into a human-readable string.
- *
- * The output is in the format:
- * - "Xh Ym Zs" if the duration is at least 1 hour,
- * - "Ym Zs" if the duration is at least 1 minute but less than 1 hour,
- * - "Zs" if the duration is less than 1 minute.
- *
- * @param {number} ms - The duration in milliseconds.
- * @returns {string} The formatted elapsed time string.
- */
-export function formatElapsed(ms) {
-    const sec = Math.floor(ms / 1000);
-    const min = Math.floor(sec / 60);
-    const hr = Math.floor(min / 60);
-    if (hr > 0) return `${hr}h ${min % 60}m ${sec % 60}s`;
-    if (min > 0) return `${min}m ${sec % 60}s`;
-    return `${sec}s`;
-}
+import { confirm } from '@inquirer/prompts';
+import logUpdate from 'log-update';
+
+const WRITE_THROTTLE_MS = 500;
+
+export async function interactiveConfirm(question, func) {
+    const result = await confirm({ message: question, default: true });
+    if (!result) return;
+    await func();
+}
+
+/**
+ * Creates a throttled status updater that periodically logs status messages and elapsed time.
+ *
+ * The updater allows you to update the displayed status message at any time, but throttles the actual log updates
+ * to the specified interval. When called with no message, the updater stops and finalizes the log output.
+ *
+ * @param {number} [intervalMs=WRITE_THROTTLE_MS] - The interval in milliseconds at which to update the log output.
+ * @returns {{
+ *   update: (message?: string) => void,
+ *   stop: () => void
+ * }} An object with `update` and `stop` methods:
+ *   - `update(message)`: Updates the status message and starts the updater if not already running. If called with no message, stops the updater.
+ *   - `stop()`: Stops the updater and finalizes the log output.
+ *
+ * @example
+ * const updater = createThrottledStatusUpdater(500);
+ * updater.update('Processing...');
+ * // ... later
+ * updater.update('Still working...');
+ * // ... when done
+ * updater.update(); // or updater.stop();
+ */
+export function createThrottledStatusUpdater(intervalMs = WRITE_THROTTLE_MS) {
+    let latestMessage;
+    let timer = null;
+    let stopped = false;
+    let startTime;
+
+    function write() {
+        const elapsed = `Elapsed:\t${formatElapsed(Date.now() - startTime)}`;
+        const lines = latestMessage ? [latestMessage, elapsed] : [elapsed];
+        logUpdate(lines.join('\n'));
+    }
+
+    function start() {
+        if (timer) return;
+
+        startTime = Date.now();
+
+        timer = setInterval(() => {
+            if (stopped) return;
+            write();
+        }, intervalMs);
+    }
+
+    function stop() {
+        stopped = true;
+        if (timer) clearInterval(timer);
+        write();
+        logUpdate.done();
+    }
+
+    // The updater function you call from anywhere
+    function update(message) {
+        if (!message) {
+            stop();
+            return;
+        }
+        latestMessage = message;
+        start();
+    }
+
+    return {
+        update,
+        stop
+    };
+}
+
+/**
+ * Converts a number of bytes into a human-readable string with appropriate units.
+ *
+ * @param {number} bytes - The number of bytes to format.
+ * @returns {string} The formatted string representing the size in appropriate units (Bytes, KB, MB, GB, TB, PB).
+ */
+export function formatBytes(bytes) {
+    if (bytes === 0) return '0 Bytes';
+    const k = 1024;
+    const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB'];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return (bytes / Math.pow(k, i)).toFixed(2) + ' ' + sizes[i];
+}
+
+/**
+ * Formats a duration given in milliseconds into a human-readable string.
+ *
+ * The output is in the format:
+ * - "Xh Ym Zs" if the duration is at least 1 hour,
+ * - "Ym Zs" if the duration is at least 1 minute but less than 1 hour,
+ * - "Zs" if the duration is less than 1 minute.
+ *
+ * @param {number} ms - The duration in milliseconds.
+ * @returns {string} The formatted elapsed time string.
+ */
+export function formatElapsed(ms) {
+    const sec = Math.floor(ms / 1000);
+    const min = Math.floor(sec / 60);
+    const hr = Math.floor(min / 60);
+    if (hr > 0) return `${hr}h ${min % 60}m ${sec % 60}s`;
+    if (min > 0) return `${min}m ${sec % 60}s`;
+    return `${sec}s`;
+}

package/package.json

@@ -1,42 +1,51 @@
-{
-  "name": "@dynamicweb/cli",
-  "type": "module",
-  "description": "Dynamicweb CLI is a commandline tool for interacting with Dynamicweb 10 solutions.",
-  "version": "1.0.15",
-  "main": "bin/index.js",
-  "files": [
-    "bin/*"
-  ],
-  "keywords": [],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "Dynamicweb A/S (https://www.dynamicweb.com)",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/dynamicweb/CLI.git"
-  },
-  "contributors": [
-    "Dynamicweb A/S"
-  ],
-  "license": "MIT",
-  "bin": {
-    "dw": "bin/index.js"
-  },
-  "bugs": {
-    "url": "https://github.com/dynamicweb/CLI/issues"
-  },
-  "dependencies": {
-    "child_process": "^1.0.2",
-    "degit": "^2.8.4",
-    "extract-zip": "^2.0.1",
-    "fetch": "^1.1.0",
-    "form-data": "^4.0.0",
-    "https": "^1.0.0",
-    "log-update": "^6.1.0",
-    "node-fetch": "^3.2.10",
-    "path": "^0.12.7",
-    "yargs": "^17.5.1",
-    "yargs-interactive": "^3.0.1"
-  }
-}
+{
+  "name": "@dynamicweb/cli",
+  "type": "module",
+  "description": "CLI for interacting with Dynamicweb 10 solutions from the command line.",
+  "version": "1.1.0",
+  "main": "bin/index.js",
+  "files": [
+    "bin/**"
+  ],
+  "keywords": [
+    "dynamicweb",
+    "cli",
+    "dynamicweb10",
+    "cms",
+    "devops"
+  ],
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Dynamicweb A/S (https://www.dynamicweb.com)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dynamicweb/CLI.git"
+  },
+  "homepage": "https://github.com/dynamicweb/CLI#readme",
+  "contributors": [
+    "Dynamicweb A/S"
+  ],
+  "license": "MIT",
+  "bin": {
+    "dw": "bin/index.js"
+  },
+  "bugs": {
+    "url": "https://github.com/dynamicweb/CLI/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20.12.0"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^8.4.1",
+    "degit": "^2.8.4",
+    "extract-zip": "^2.0.1",
+    "form-data": "^4.0.0",
+    "log-update": "^6.1.0",
+    "node-fetch": "^3.2.10",
+    "yargs": "^17.5.1"
+  }
+}