@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/util/wait-for-it.js

@@ -1,46 +1,55 @@
-const net = require('net');
-const UnknownError = require('../errors/unknown-error');
-const sleep = require('./sleep');
+const net = require('net')
+const UnknownError = require('../errors/unknown-error')
+const sleep = require('./sleep')
 
-const connectToHostPort = ({ host, port }) => new Promise((resolve, reject) => {
-    const socket = net.createConnection({ host, port, timeout: 15 * 1000 });
+/**
+ * @param {{ host: string, port: number}} param0
+ * @returns {Promise<void>}
+ */
+const connectToHostPort = ({ host, port }) =>
+    new Promise((resolve, reject) => {
+        const socket = net.createConnection({ host, port, timeout: 15 * 1000 })
 
-    socket.on('connect', () => {
-        socket.end();
-        resolve();
-    });
-    socket.on('error', (err) => {
-        socket.end();
-        reject(err);
-    });
-    socket.on('timeout', () => {
-        socket.end();
-        reject(new UnknownError('Connection timeout'));
-    });
-});
+        socket.on('connect', () => {
+            socket.end()
+            resolve()
+        })
+        socket.on('error', (err) => {
+            socket.end()
+            reject(err)
+        })
+        socket.on('timeout', () => {
+            socket.end()
+            reject(new UnknownError('Connection timeout'))
+        })
+    })
 
-const waitForIt = async ({
-    name, host, port, output
-}) => {
-    const startTime = Date.now();
-    let connected = false;
-    output(`Waiting for ${name} at ${host}:${port}...`);
+/**
+ * @param {{ name: string, host: string, port: number, output: (arg: string) => void }} param0
+ */
+const waitForIt = async ({ name, host, port, output }) => {
+    const startTime = Date.now()
+    let connected = false
+    output(`Waiting for ${name} at ${host}:${port}...`)
     while (!connected) {
         try {
-            // eslint-disable-next-line no-await-in-loop
             await Promise.race([
                 sleep(300).then(() => {
-                    throw new UnknownError('Connection timeout');
+                    throw new UnknownError('Connection timeout')
                 }),
                 connectToHostPort({ host, port })
-            ]);
-            connected = true;
-        // eslint-disable-next-line no-empty
+            ])
+            connected = true
         } catch {}
     }
 
-    const endTime = Date.now();
-    output(`${name} at ${host}:${port} is available after ${((endTime - startTime) / 1000).toFixed(0)} seconds`, 3);
-};
+    const endTime = Date.now()
+    output(
+        `${name} at ${host}:${port} is available after ${(
+            (endTime - startTime) /
+            1000
+        ).toFixed(0)} seconds`
+    )
+}
 
-module.exports = waitForIt;
+module.exports = waitForIt

package/lib/util/wait-for-logs.js

@@ -1,41 +1,48 @@
-const { execAsyncSpawn } = require('./exec-async-command');
-const sleep = require('./sleep');
+const { execAsyncSpawn } = require('./exec-async-command')
+const sleep = require('./sleep')
 
-// eslint-disable-next-line no-async-promise-executor
-const waitForLogs = ({ containerName, timeout = 30 * 1000, matchText }) => new Promise(async (resolve, reject) => {
-    let matched = false;
-    let timeoutExceeded = false;
-    await Promise.race([
-        (async () => {
-            while (!timeoutExceeded && !matched) {
-                // eslint-disable-next-line no-await-in-loop
-                const { result } = await execAsyncSpawn(`docker logs ${containerName}`, {
-                    withCode: true
-                });
+/**
+ * @param {{ containerName: string, timeout?: number, matchText: string }} param0
+ * @returns {Promise<void>}
+ */
+const waitForLogs = ({ containerName, timeout = 30 * 1000, matchText }) =>
+    // eslint-disable-next-line no-async-promise-executor
+    new Promise(async (resolve, reject) => {
+        let matched = false
+        let timeoutExceeded = false
+        await Promise.race([
+            (async () => {
+                // eslint-disable-next-line no-unmodified-loop-condition
+                while (!timeoutExceeded && !matched) {
+                    const { result } = await execAsyncSpawn(
+                        `docker logs ${containerName}`,
+                        {
+                            withCode: true
+                        }
+                    )
 
-                if (matched) {
-                    return;
-                }
-                // eslint-disable-next-line no-loop-func
-                result.split('\n').forEach((line) => {
-                    if (line.includes(matchText)) {
-                        matched = true;
-                        resolve();
+                    if (matched) {
+                        return
                     }
-                });
 
-                // eslint-disable-next-line no-await-in-loop
-                await sleep(500);
-            }
-        })(),
-        sleep(timeout).then(() => {
-            timeoutExceeded = true;
-        })
-    ]);
+                    result.split('\n').forEach((line) => {
+                        if (line.includes(matchText)) {
+                            matched = true
+                            resolve()
+                        }
+                    })
+
+                    await sleep(500)
+                }
+            })(),
+            sleep(timeout).then(() => {
+                timeoutExceeded = true
+            })
+        ])
 
-    if (timeoutExceeded) {
-        reject(new Error('Timeout exception'));
-    }
-});
+        if (timeoutExceeded) {
+            reject(new Error('Timeout exception'))
+        }
+    })
 
-module.exports = waitForLogs;
+module.exports = waitForLogs

package/lib/util/xdg-open-exists.js

@@ -1,27 +1,27 @@
-const fs = require('fs');
-const pathExists = require('./path-exists');
+const fs = require('fs')
+const pathExists = require('./path-exists')
 
 const checkForXDGOpen = async () => {
-    const pathParts = process.env.PATH.split(':');
+    const pathParts = process.env.PATH.split(':')
 
     const results = await Promise.all(
-        pathParts.map(
-            async (pathPart) => {
-                if (!await pathExists(pathPart)) {
-                    return false;
-                }
+        pathParts.map(async (pathPart) => {
+            if (!(await pathExists(pathPart))) {
+                return false
+            }
 
-                const files = await fs.promises.readdir(pathPart, {
-                    encoding: 'utf-8',
-                    withFileTypes: true
-                });
+            const files = await fs.promises.readdir(pathPart, {
+                encoding: 'utf-8',
+                withFileTypes: true
+            })
 
-                return files.some((file) => file.isFile() && file.name === 'xdg-open');
-            }
-        )
-    );
+            return files.some(
+                (file) => file.isFile() && file.name === 'xdg-open'
+            )
+        })
+    )
 
-    return results.includes(true);
-};
+    return results.includes(true)
+}
 
-module.exports = checkForXDGOpen;
+module.exports = checkForXDGOpen

package/package.json

@@ -3,7 +3,7 @@
     "description": "Scripts and configuration used by CMA.",
     "homepage": "https://docs.create-magento-app.com/",
     "repository": "github:scandipwa/create-magento-app",
-    "version": "2.0.3",
+    "version": "2.0.4",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -23,7 +23,8 @@
         "arm64"
     ],
     "dependencies": {
-        "@scandipwa/scandipwa-dev-utils": "0.1.13",
+        "@scandipwa/scandipwa-dev-utils": "0.1.16",
+        "@tilework/mosaic-dev-utils": "^0.2.3",
         "conf": "10.1.2",
         "enquirer": "2.3.6",
         "eta": "1.12.3",
@@ -54,5 +55,8 @@
         "mysql",
         "scandipwa"
     ],
-    "gitHead": "21913f16c2eb9b18f7e35d0e19df0c30373044fc"
+    "devDependencies": {
+        "@types/yargs": "^17.0.13"
+    },
+    "gitHead": "0938871489021e7a165a42b24d45775107a32870"
 }

package/tsconfig.json

@@ -0,0 +1,24 @@
+{
+    "compilerOptions": {
+        "allowJs": true,
+        "checkJs": true,
+        "strict": true,
+        "forceConsistentCasingInFileNames": true,
+        "resolveJsonModule": true,
+        "skipLibCheck": true,
+        "module": "CommonJS",
+        "lib": ["ES2022"],
+        "target": "ES2022",
+        "moduleResolution": "Node",
+        "types": [
+            "./typings"
+        ]
+    },
+    "exclude": [
+        "**/node_modules",
+        "./lib/config/templates/**"
+    ],
+    "include": [
+        "./"
+    ]
+}

package/typings/context.d.ts

@@ -1,16 +1,42 @@
-import mysql2 from 'mysql2';
+import * as mysql2 from 'mysql2'
 
-import { ProjectConfig } from '../lib/config/config';
-import { DockerVersionResult } from '../lib/tasks/docker/api';
-import { CMAConfiguration, PHPExtensions } from './index';
-import { PHPStormConfig } from './phpstorm';
+import { ProjectConfig } from '../lib/config/config'
+import { DockerVersionResult } from '../lib/tasks/docker/api'
+import { systemApi } from '../lib/tasks/docker/system'
+import { CMAConfiguration, PHPExtensions } from './index'
+import { PHPStormConfig } from './phpstorm'
 
 export interface ListrContext {
+    noOpen?: boolean
+    skipSetup?: boolean
+    resetGlobalConfig?: boolean
+    withCustomersData?: boolean
+    force?: boolean
+    magentoFirstInstall?: boolean
+    encryptionKey?: string
+    pullImages?: boolean
+    throwMagentoVersionMissing: boolean
+    projectPath: string
+    systemDFData?: systemApi.SystemDFResult
+    debug: boolean
+    verbose: boolean
     magentoVersion: string
     composerVersion: string
     phpVersion: string
     port?: number
-    ports?: {
+    ports: {
+        app: number
+        fpm: number
+        xdebug: number
+        mariadb: number
+        redis: number
+        elasticsearch: number
+        varnish: number
+        sslTerminator: number
+        maildevSMTP: number
+        maildevWeb: number
+    }
+    cachedPorts?: {
         app: number
         fpm: number
         xdebug: number
@@ -50,33 +76,39 @@ export interface ListrContext {
             network: {
                 name: string
             }
-            volumes: Record<'mariadb' | 'redis' | 'elasticsearch' | 'nginx' | 'appPub' | 'appSetup', {
-                name: string
-                opt?: {
-                    type: string
-                    device: string
-                    o: string
+            volumes: Record<string,
+                {
+                    name: string,
+                    driver?: string,
+                    opt?: {
+                        mode?: string,
+                        device?: string,
+                        o?: string,
+                        type?: string
+                    }
                 }
-            }>
-            getContainers(): Record<'php' | 'sslTerminator' | 'nginx' | 'redis' | 'mariadb' | 'elasticsearch' | 'varnish', {
-                _: string
-                ports: string[]
-                healthCheck: {
-                    cmd: string
+            >
+            getContainers(ports?: Record<string, number>): Record<string,
+                {
+                    _: string
+                    ports: string[]
+                    healthCheck: {
+                        cmd: string
+                    }
+                    env: Record<string, string>
+                    mountVolumes: string[]
+                    mounts: string[]
+                    restart: string
+                    securityOptions: string[]
+                    network: string
+                    image: string
+                    debugImage?: string
+                    remoteImages?: string[]
+                    name: string
+                    command: string
+                    connectCommand: string[]
                 }
-                env: Record<string, string>
-                mountVolumes: string[]
-                mounts: string[]
-                restart: string
-                securityOptions: string[]
-                network: string
-                image: string
-                debugImage?: string
-                remoteImages?: string[]
-                name: string
-                command: string
-                connectCommand: string[]
-            }>
+            >
         }
         baseConfig: {
             prefix: string
@@ -85,11 +117,21 @@ export interface ListrContext {
             cacheDir: string
             containerMagentoDir: string
         }
-        overridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
-        userConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
-        nonOverridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
+        overridenConfiguration: Required<Omit<
+            CMAConfiguration,
+            'useNonOverlappingPorts'
+        > & { magentoVersion: string }>
+        userConfiguration:  Omit<
+            CMAConfiguration,
+            'useNonOverlappingPorts'
+        >
+        nonOverridenConfiguration:  Required<Omit<
+            CMAConfiguration,
+            'useNonOverlappingPorts'
+        >>
         phpStorm: PHPStormConfig
         projectConfig: ProjectConfig
+        magentoConfiguration: CMAConfiguration['magento']
     }
     systemConfiguration: {
         analytics: boolean

package/typings/index.d.ts

@@ -1,4 +1,5 @@
-import { ListrContext } from './context';
+import { ListrContext } from './context'
+import './override'
 
 /* eslint-disable no-use-before-define */
 export interface ServiceWithImage {
@@ -7,7 +8,7 @@ export interface ServiceWithImage {
      *
      * @deprecated
      */
-    version: string
+    version?: string
 
     /**
      * Service Docker image
@@ -84,14 +85,17 @@ export interface ComposerConfiguration {
     /**
      *  Composer global plugins that will be added to Docker image
      */
-    plugins: Record<string, {
-        version?: string
-        options?: string
-        /**
-         * Enable composer plugin
-         */
-        enabled?: boolean
-    }>
+    plugins?: Record<
+        string,
+        {
+            version?: string
+            options?: string
+            /**
+             * Enable composer plugin
+             */
+            enabled?: boolean
+        }
+    >
 }
 
 export interface PHPExtensionInstallationInstruction {
@@ -117,9 +121,18 @@ export interface PHPExtensionInstallationInstruction {
      * pecl install xdebug && docker-php-ext-enable xdebug
      * ```
      */
-    command: string |
-        ((arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => string) |
-        ((arg0: (Omit<PHPExtensionInstallationInstruction, 'command'> & { ctx: ListrContext})) => Promise<string>)
+    command:
+        | string
+        | ((
+              arg0: Omit<PHPExtensionInstallationInstruction, 'command'> & {
+                  ctx: ListrContext
+              }
+          ) => string)
+        | ((
+              arg0: Omit<PHPExtensionInstallationInstruction, 'command'> & {
+                  ctx: ListrContext
+              }
+          ) => Promise<string>)
 
     /**
      * System dependencies required by the extension
@@ -144,12 +157,12 @@ export interface PHPConfiguration {
     /**
      * Base image with tag
      */
-    baseImage?: string
+    baseImage: string
 
     /**
      * Image with XDebug enabled
      */
-    debugImage?: string
+    debugImage: string
 
     /**
      * Configuration file template location
@@ -188,7 +201,7 @@ export interface SSLConfiguration {
      * @example
      * `./ssl_certificate.pem`
      */
-    ssl_certificate: string
+    ssl_certificate?: string
 
     /**
      * SSL certificate key name
@@ -196,7 +209,7 @@ export interface SSLConfiguration {
      * @example
      * `./ssl_certificate-key.pem`
      */
-    ssl_certificate_key: string
+    ssl_certificate_key?: string
 }
 
 export interface CMAConfiguration {
@@ -243,6 +256,18 @@ export interface CMAConfiguration {
          * SSL Terminator configuration
          */
         sslTerminator: SSLTerminatorConfiguration
+
+        /**
+         * MailDev configuration
+         */
+        maildev: ServiceWithImage
+
+        /**
+         * @deprecated MySQL configuration
+         */
+        mysql: {
+            version: string
+        }
     }
     /**
      * Magento configuration
@@ -285,7 +310,7 @@ export interface CMAConfiguration {
     /**
      * SSL Configuration
      */
-    ssl: SSLConfiguration
+    ssl?: SSLConfiguration
 
     /**
      * Prefix config.
@@ -297,5 +322,5 @@ export interface CMAConfiguration {
      * interference between folders with similar names.
      * If prefix is set to `false` docker container and volume names will only include folder name **which is not safe and not recommended**.
      */
-    prefix: boolean
+    prefix?: boolean
 }

package/typings/override.d.ts

@@ -0,0 +1,14 @@
+
+declare namespace NodeJS {
+    export interface ProcessEnv {
+        PATH: string
+        COMPOSER_AUTH?: string
+        SHELL: string
+    }
+
+    export interface Process {
+        isFirstStart?: number
+        isOutOfDateVersion?: boolean
+        isOutOfDateVersionMessage?: string[]
+    }
+}

package/typings/phpstorm.d.ts

@@ -1,33 +1,33 @@
 export interface PHPStormConfig {
     xdebug: {
-        v2Port: string;
-        v3Port: string;
-        debugServerAddress: string;
-        serverName: string;
-        runManagerName: string;
-        sessionId: string;
-        path: string;
-        templatePath: string;
+        v2Port: string
+        v3Port: string
+        debugServerAddress: string
+        serverName: string
+        runManagerName: string
+        sessionId: string
+        path: string
+        templatePath: string
     }
     php: {
-        phpLanguageLevel: string;
-        path: string;
-        templatePath: string;
+        phpLanguageLevel: string
+        path: string
+        templatePath: string
     }
     database: {
-        driver: string;
-        dataSourceManagerName: string;
+        driver: string
+        dataSourceManagerName: string
         dataSourcesLocal: {
-            path: string;
-            templatePath: string;
+            path: string
+            templatePath: string
         }
         dataSources: {
-            path: string;
-            templatePath: string;
+            path: string
+            templatePath: string
         }
     }
     inspectionTools: {
-        path: string;
-        templatePath: string;
+        path: string
+        templatePath: string
     }
 }

package/.prettierrc

@@ -1,3 +0,0 @@
-{
-    "tabWidth": 4
-}

package/lib/util/get-php-for-phpbrew.js

@@ -1,30 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const phpbrewConfig = require('../config/phpbrew');
-const pathExists = require('./path-exists');
-
-const getPHPForPHPBrewBin = async () => {
-    if (!await pathExists(phpbrewConfig.phpPath)) {
-        return '';
-    }
-
-    const buildedPHPs = await fs.promises.readdir(phpbrewConfig.phpPath, {
-        encoding: 'utf-8',
-        withFileTypes: true
-    });
-
-    const phpForPHPBrew = buildedPHPs.find((p) => p.isDirectory() && p.name.endsWith('phpbrew'));
-
-    if (phpForPHPBrew) {
-        const phpBinPath = path.join(phpbrewConfig.phpPath, phpForPHPBrew.name, 'bin');
-        if (await pathExists(phpBinPath)) {
-            return phpBinPath;
-        }
-    }
-
-    return '';
-};
-
-module.exports = {
-    getPHPForPHPBrewBin
-};