@scandipwa/magento-scripts 2.0.3 → 2.0.5

package/lib/util/dockerfile-builder/index.js

@@ -1,30 +1,25 @@
-const { buildInstructions } = require('./build-instructions');
+const { buildInstructions } = require('./build-instructions')
 
 class DockerFileBuilder {
     /**
      * @type {import('./types').DockerfileInstruction[]}
      */
-    instructions = [];
+    instructions = []
 
     /**
      * @param {Omit<import('./types').FromInstruction, 'type'>} param0
      * @returns {this}
      */
-    from({
-        image,
-        tag = 'latest',
-        platform,
-        name
-    }) {
+    from({ image, tag = 'latest', platform, name }) {
         this.instructions.push({
             type: 'FROM',
             image,
             tag,
             platform,
             name
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -34,9 +29,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'RUN',
             command
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -46,9 +41,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'CMD',
             command
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -58,25 +53,22 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'LABEL',
             labels
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
      * @param {Omit<import('./types').ExposeInstruction, 'type'>} param0
      */
-    expose({
-        port,
-        protocol
-    }) {
+    expose({ port, protocol }) {
         this.instructions.push({
             type: 'EXPOSE',
             port,
             protocol
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -88,48 +80,39 @@ class DockerFileBuilder {
                 type: 'ENV',
                 name,
                 value
-            });
-        });
+            })
+        })
 
-        return this;
+        return this
     }
 
     /**
      * @param {Omit<import('./types').AddInstruction, 'type'>} param0
      */
-    add({
-        src,
-        dest,
-        chown
-    }) {
+    add({ src, dest, chown }) {
         this.instructions.push({
             type: 'ADD',
             src,
             dest,
             chown
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
      * @param {Omit<import('./types').CopyInstruction, 'type'>} param0
      */
-    copy({
-        src,
-        dest,
-        chown,
-        from
-    }) {
+    copy({ src, dest, chown, from }) {
         this.instructions.push({
             type: 'COPY',
             src,
             dest,
             chown,
             from
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -139,9 +122,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'ENTRYPOINT',
             command
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -151,9 +134,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'VOLUME',
             volume
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -163,9 +146,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'USER',
             user
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -175,25 +158,22 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'WORKDIR',
             workdir
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
      * @param {Omit<import('./types').ArgInstruction, 'type'>} param0
      */
-    arg({
-        name,
-        defaultValue
-    }) {
+    arg({ name, defaultValue }) {
         this.instructions.push({
             type: 'ARG',
             name,
             defaultValue
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -203,9 +183,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'ONBUILD',
             instruction
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -215,21 +195,15 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'STOPSIGNAL',
             signal
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
      * @param {Omit<import('./types').HealthCheckInstruction, 'type'>} param0
      */
-    healthCheck({
-        command,
-        interval,
-        timeout,
-        startPeriod,
-        retries
-    }) {
+    healthCheck({ command, interval, timeout, startPeriod, retries }) {
         this.instructions.push({
             type: 'HEALTHCHECK',
             command,
@@ -237,9 +211,9 @@ class DockerFileBuilder {
             retries,
             startPeriod,
             timeout
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -249,9 +223,9 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'SHELL',
             exec
-        });
+        })
 
-        return this;
+        return this
     }
 
     /**
@@ -261,16 +235,16 @@ class DockerFileBuilder {
         this.instructions.push({
             type: 'COMMENT',
             comment
-        });
+        })
 
-        return this;
+        return this
     }
 
     build() {
-        return buildInstructions(this.instructions);
+        return buildInstructions(this.instructions)
     }
 }
 
 module.exports = {
     DockerFileBuilder
-};
+}

package/lib/util/dockerfile-builder/types.d.ts

@@ -103,7 +103,8 @@ export interface CommentInstruction {
     comment: string
 }
 
-export type DockerfileInstruction = FromInstruction
+export type DockerfileInstruction =
+    | FromInstruction
     | RunInstruction
     | CmdInstruction
     | LabelInstruction

package/lib/util/download-file.js

@@ -1,21 +1,33 @@
-const https = require('https');
-const http = require('http');
-const fs = require('fs');
+const https = require('https')
+const http = require('http')
+const fs = require('fs')
 
-const downloadFile = (url, { destination } = {}) => new Promise((resolve, reject) => {
-    const client = url.startsWith('https') ? https : http;
+/**
+ * @param {string} url
+ * @param {Object} param1
+ * @param {string} param1.destination
+ * @returns {Promise<void>}
+ */
+const downloadFile = (url, { destination }) =>
+    new Promise((resolve, reject) => {
+        const client = url.startsWith('https') ? https : http
 
-    const writeStream = fs.createWriteStream(destination, { encoding: 'utf-8' });
+        const writeStream = fs.createWriteStream(destination, {
+            encoding: 'utf-8'
+        })
 
-    const onError = (err) => {
-        reject(err);
-    };
-    const req = client.get(url, (res) => {
-        res.pipe(writeStream);
-    });
+        /**
+         * @param {Error} err
+         */
+        const onError = (err) => {
+            reject(err)
+        }
+        const req = client.get(url, (res) => {
+            res.pipe(writeStream)
+        })
 
-    req.on('error', onError);
-    req.once('close', resolve);
-});
+        req.on('error', onError)
+        req.once('close', resolve)
+    })
 
-module.exports = downloadFile;
+module.exports = downloadFile

package/lib/util/env-php-json.js

@@ -1,29 +1,55 @@
-const path = require('path');
-const UnknownError = require('../errors/unknown-error');
-const { runPHPContainerCommand } = require('../tasks/php/php-container');
-const pathExists = require('./path-exists');
+const path = require('path')
+const UnknownError = require('../errors/unknown-error')
+const { runPHPContainerCommand } = require('../tasks/php/php-container')
+const pathExists = require('./path-exists')
+
+/**
+ * @typedef EnvPHPData
+ *
+ * @prop {Record<string, number>} cache_types
+ * @prop {{ key: string }} crypt
+ */
 
 /**
  * @param {import('../../typings/context').ListrContext} ctx
+ * @returns {Promise<EnvPHPData | null>}
  */
 const envPhpToJson = async (ctx) => {
-    const envPhpOnSystemPath = path.join(ctx.config.baseConfig.magentoDir, 'app', 'etc', 'env.php');
-    const envPhpInContainerPath = path.join(ctx.config.baseConfig.containerMagentoDir, 'app', 'etc', 'env.php');
-    if (!await pathExists(envPhpOnSystemPath)) {
-        return null;
+    const envPhpOnSystemPath = path.join(
+        ctx.config.baseConfig.magentoDir,
+        'app',
+        'etc',
+        'env.php'
+    )
+    const envPhpInContainerPath = path.join(
+        ctx.config.baseConfig.containerMagentoDir,
+        'app',
+        'etc',
+        'env.php'
+    )
+    if (!(await pathExists(envPhpOnSystemPath))) {
+        return null
     }
-    const { code, result } = await runPHPContainerCommand(ctx, `php -r "echo json_encode(require '${envPhpInContainerPath}');"`, {
-        withCode: true
-    });
+    const { code, result } = await runPHPContainerCommand(
+        ctx,
+        `php -r "echo json_encode(require '${envPhpInContainerPath}');"`,
+        {
+            withCode: true
+        }
+    )
 
     if (code !== 0) {
-        throw new UnknownError(`Received non-zero code during converting app/etc/env.php to json:\n\n${result}`);
+        throw new UnknownError(
+            `Received non-zero code during converting app/etc/env.php to json:\n\n${result}`
+        )
     }
     try {
-        return JSON.parse(result);
+        return JSON.parse(result)
     } catch (e) {
-        throw new UnknownError(`Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`);
+        throw new UnknownError(
+            `Ooops! Something went wrong when trying to parse app/etc/env.php file!\n\n${e}\n\nFile result: ${result}`
+        )
     }
-};
+}
 
-module.exports = envPhpToJson;
+module.exports = envPhpToJson

package/lib/util/exec-async-command.d.ts

@@ -1,7 +1,7 @@
-/* eslint-disable max-len */
-import { ListrTask } from 'listr2';
+/* eslint-disable no-redeclare */
+import { ListrTask } from 'listr2'
 
-import { ListrContext } from '../../typings/context';
+import { ListrContext } from '../../typings/context'
 
 interface ExecAsyncSpawnOptions<T extends boolean> {
     callback?: (result: string) => void
@@ -9,9 +9,9 @@ interface ExecAsyncSpawnOptions<T extends boolean> {
     logOutput?: boolean
     cwd?: string
     withCode?: T
+    env?: Record<string, string> & NodeJS.ProcessEnv
     // only for mac
     useRosetta2?: boolean
-    env: NodeJS.ProcessEnv
 }
 
 /**
@@ -20,13 +20,13 @@ interface ExecAsyncSpawnOptions<T extends boolean> {
 export function execAsyncSpawn(
     command: string,
     options?: ExecAsyncSpawnOptions<false>
-): Promise<string>;
-export function execAsyncSpawn (
+): Promise<string>
+export function execAsyncSpawn(
     command: string,
     options?: ExecAsyncSpawnOptions<true>
-): Promise<{ code: number, result: string }>;
+): Promise<{ code: number; result: string }>
 
-export function execCommandTask(
+export function execCommandTask<T extends boolean>(
     command: string,
-    options?: Omit<ExecAsyncSpawnOptions<false>, 'callback'>
+    options?: Omit<ExecAsyncSpawnOptions<T>, 'callback'>
 ): ListrTask<ListrContext>

package/lib/util/exec-async-command.js

@@ -1,18 +1,24 @@
-const os = require('os');
-const logger = require('@scandipwa/scandipwa-dev-utils/logger');
-const { spawn } = require('child_process');
-const { getArchSync } = require('./arch');
-const UnknownError = require('../errors/unknown-error');
+const os = require('os')
+const logger = require('@scandipwa/scandipwa-dev-utils/logger')
+const { spawn } = require('child_process')
+const { getArchSync } = require('./arch')
+const UnknownError = require('../errors/unknown-error')
 
-const execAsyncSpawn = (command, {
-    callback = () => {},
-    pipeInput,
-    logOutput = false,
-    cwd,
-    withCode = false,
-    useRosetta2 = false,
-    env = process.env
-} = {}) => {
+/**
+ * @type {typeof import('./exec-async-command')['execAsyncSpawn']}
+ */
+const execAsyncSpawn = (
+    command,
+    {
+        callback,
+        pipeInput,
+        logOutput = false,
+        cwd,
+        withCode = false,
+        useRosetta2 = false,
+        env = process.env
+    } = {}
+) => {
     /**
      * @type {import('child_process').SpawnOptionsWithoutStdio}
      */
@@ -20,81 +26,98 @@ const execAsyncSpawn = (command, {
         stdio: pipeInput ? ['inherit', 'pipe', 'pipe'] : 'pipe',
         cwd,
         env
-    };
+    }
 
     /**
      * @type {import('child_process').ChildProcessWithoutNullStreams}
      */
-    let childProcess;
-    if (useRosetta2 && os.platform() === 'darwin' && getArchSync() === 'arm64') {
+    let childProcess
+    if (
+        useRosetta2 &&
+        os.platform() === 'darwin' &&
+        getArchSync() === 'arm64'
+    ) {
         childProcess = spawn(
             'arch',
-            // eslint-disable-next-line max-len
             ['-x86_64', 'bash', '-c', command],
             spawnOptions
-        );
+        )
     } else {
-        childProcess = spawn(
-            'bash',
-            ['-c', command],
-            spawnOptions
-        );
+        childProcess = spawn('bash', ['-c', command], spawnOptions)
     }
 
     return new Promise((resolve, reject) => {
-        const chunks = [];
+        /**
+         * @type {Buffer[]}
+         */
+        const chunks = []
 
         /**
          * @param {Buffer} chunk
          */
         const addChunk = (chunk) => {
-            chunks.push(Buffer.from(chunk));
-            const newData = chunk.toString('utf-8');
-            newData.split('\n').map((str) => str.trim()).forEach((str) => {
-                callback(str);
-            });
+            chunks.push(Buffer.from(chunk))
+            const newData = chunk.toString('utf-8')
+            newData
+                .split('\n')
+                .map((str) => str.trim())
+                .forEach((str) => {
+                    callback && callback(str)
+                })
             if (logOutput) {
-                newData.split('\n').filter(Boolean).forEach((line) => {
-                    logger.log(line);
-                });
+                newData
+                    .split('\n')
+                    .filter(Boolean)
+                    .forEach((line) => {
+                        logger.log(line)
+                    })
             }
-        };
+        }
 
-        childProcess.stdout.on('data', addChunk);
-        childProcess.stderr.on('data', addChunk);
+        childProcess.stdout.on('data', addChunk)
+        childProcess.stderr.on('data', addChunk)
 
         childProcess.on('error', (error) => {
-            reject(error);
-        });
+            reject(error)
+        })
         childProcess.on('close', (code) => {
-            const result = Buffer.concat(chunks).toString('utf8').trim();
-            if (withCode) {
-                resolve({ code, result });
-                return;
+            const result = Buffer.concat(chunks).toString('utf8').trim()
+            if (typeof code === 'number') {
+                if (withCode) {
+                    resolve({ code, result })
+                    return
+                }
+                if (code > 0) {
+                    reject(new UnknownError(result))
+                    return
+                }
             }
-            if (code > 0) {
-                reject(new UnknownError(result));
-            } else {
-                resolve(result);
-            }
-        });
-    });
-};
 
+            resolve(result)
+        })
+    })
+}
+
+/**
+ * @type {typeof import('./exec-async-command')['execCommandTask']}
+ */
 const execCommandTask = (command, options = {}) => ({
     title: `Running command "${command}"`,
-    task: (ctx, task) => execAsyncSpawn(command, {
-        callback: !ctx.verbose ? undefined : (t) => {
-            task.output = t;
-        },
-        ...options
-    }),
-    option: {
+    task: (ctx, task) =>
+        execAsyncSpawn(command, {
+            callback: !ctx.verbose
+                ? undefined
+                : (t) => {
+                      task.output = t
+                  },
+            ...options
+        }),
+    options: {
         bottomBar: 10
     }
-});
+})
 
 module.exports = {
     execAsyncSpawn,
     execCommandTask
-};
+}

package/lib/util/exec-async.d.ts

@@ -1,4 +1,6 @@
 /* eslint-disable max-len */
+import { ExecOptions } from 'child_process'
+
 /**
  * Execute bash command
  * @param command Bash command

package/lib/util/exec-async.js

@@ -1,9 +1,16 @@
-const { exec } = require('child_process');
+const { exec } = require('child_process')
 
-const execAsync = (command, options) => new Promise((resolve, reject) => {
-    exec(command, options, (err, stdout) => (err ? reject(err) : resolve(stdout)));
-});
+/**
+ * @param {string} command
+ * @param {{ encoding: 'buffer' | null; } & import('child_process').ExecOptions} options
+ */
+const execAsync = (command, options) =>
+    new Promise((resolve, reject) => {
+        exec(command, options, (err, stdout) =>
+            err ? reject(err) : resolve(stdout)
+        )
+    })
 
 module.exports = {
     execAsync
-};
+}