@scandipwa/magento-scripts 2.0.3 → 2.0.5

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
@@ -15,6 +16,15 @@ export interface ServiceWithImage {
     image: string
 }
 
+export interface MariaDBConfiguration extends ServiceWithImage {
+    /**
+     * Use MariaDB [optimizer-switch](https://mariadb.com/kb/en/optimizer-switch/) configuration.
+     *
+     * Allows to be boolean or custom value that will be set in the template
+     */
+    useOptimizerSwitch?: boolean | string
+}
+
 export interface SSLTerminatorConfiguration extends ServiceWithImage {
     /**
      * Configuration file location
@@ -84,14 +94,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 +130,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 +166,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 +210,7 @@ export interface SSLConfiguration {
      * @example
      * `./ssl_certificate.pem`
      */
-    ssl_certificate: string
+    ssl_certificate?: string
 
     /**
      * SSL certificate key name
@@ -196,7 +218,7 @@ export interface SSLConfiguration {
      * @example
      * `./ssl_certificate-key.pem`
      */
-    ssl_certificate_key: string
+    ssl_certificate_key?: string
 }
 
 export interface CMAConfiguration {
@@ -217,7 +239,7 @@ export interface CMAConfiguration {
         /**
          * MariaDB configuration
          */
-        mariadb: ServiceWithImage
+        mariadb: MariaDBConfiguration
 
         /**
          * ElasticSearch configuration
@@ -243,6 +265,18 @@ export interface CMAConfiguration {
          * SSL Terminator configuration
          */
         sslTerminator: SSLTerminatorConfiguration
+
+        /**
+         * MailDev configuration
+         */
+        maildev: ServiceWithImage
+
+        /**
+         * @deprecated MySQL configuration
+         */
+        mysql: {
+            version: string
+        }
     }
     /**
      * Magento configuration
@@ -285,7 +319,7 @@ export interface CMAConfiguration {
     /**
      * SSL Configuration
      */
-    ssl: SSLConfiguration
+    ssl?: SSLConfiguration
 
     /**
      * Prefix config.
@@ -297,5 +331,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
-};