@scandipwa/magento-scripts 1.11.3 → 1.12.2

package/lib/tasks/php/extensions/install.js

@@ -0,0 +1,47 @@
+/* eslint-disable max-len */
+const macosVersion = require('macos-version');
+const { execAsyncSpawn } = require('../../../util/exec-async-command');
+
+/**
+ * @param {String} extensionName
+ * @param {import('../../../../typings/index').PHPExtension} extensionOptions
+ * @returns {import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
+ */
+const installExtension = (extensionName, extensionOptions) => ({
+    title: `Installing ${extensionName} extension`,
+    task: async (ctx, task) => {
+        const {
+            config,
+            config: { php }
+        } = ctx;
+        const { hooks } = extensionOptions;
+
+        if (extensionOptions.install) {
+            await Promise.resolve(extensionOptions.install(ctx, task));
+        } else {
+            const options = macosVersion.isMacOS ? extensionOptions.macosOptions : extensionOptions.linuxOptions;
+
+            if (hooks && hooks.preInstall) {
+                await Promise.resolve(hooks.preInstall(config));
+            }
+
+            await execAsyncSpawn(`source ~/.phpbrew/bashrc && \
+                phpbrew use ${ php.version } && \
+                phpbrew ext install ${ extensionName }${ extensionOptions.version ? ` ${extensionOptions.version}` : ''}${ options ? ` -- ${ options }` : ''}`,
+            {
+                callback: (t) => {
+                    task.output = t;
+                }
+            });
+
+            if (hooks && hooks.postInstall) {
+                await Promise.resolve(hooks.postInstall(config));
+            }
+        }
+    },
+    options: {
+        bottomBar: 10
+    }
+});
+
+module.exports = installExtension;

package/lib/tasks/php-fpm/start-php-fpm.js

@@ -1,5 +1,5 @@
 const { execAsyncSpawn } = require('../../util/exec-async-command');
-const getPhpConfig = require('../../config/php');
+const getPhpConfig = require('../../config/php-config');
 const { getBaseConfig } = require('../../config/index');
 const getProcessId = require('./get-process-id');
 
@@ -7,7 +7,7 @@ const getProcessId = require('./get-process-id');
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const startPhpFpm = () => ({
-    title: 'Starting php-fpm',
+    title: 'Starting PHP-FPM',
     task: async ({ config: { overridenConfiguration }, projectPath }, task) => {
         const php = getPhpConfig(overridenConfiguration.configuration, getBaseConfig(projectPath));
         const processId = await getProcessId(php.fpmPidFilePath);
@@ -35,7 +35,7 @@ const startPhpFpm = () => ({
                 }
             );
         } catch (e) {
-            throw new Error(`Error during php-fpm start\n\n${e}`);
+            throw new Error(`Error during PHP-FPM start\n\n${e}`);
         }
     },
     options: {

package/lib/tasks/php-fpm/stop-php-fpm.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const { execAsyncSpawn } = require('../../util/exec-async-command');
 const pathExists = require('../../util/path-exists');
-const getPhpConfig = require('../../config/php');
+const getPhpConfig = require('../../config/php-config');
 const { getBaseConfig } = require('../../config/index');
 const getProcessId = require('./get-process-id');
 
@@ -9,7 +9,7 @@ const getProcessId = require('./get-process-id');
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const stopPhpFpmTask = () => ({
-    title: 'Stopping php-fpm',
+    title: 'Stopping PHP-FPM',
     task: async ({ config: { overridenConfiguration }, projectPath }, task) => {
         const php = getPhpConfig(overridenConfiguration.configuration, getBaseConfig(projectPath));
         const processId = await getProcessId(php.fpmPidFilePath);

package/lib/tasks/requirements/composer.js

@@ -4,7 +4,7 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger');
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkComposer = () => ({
-    title: 'Checking composer environmental variables',
+    title: 'Checking Composer environmental variables',
     task: () => {
         try {
             if (!process.env.COMPOSER_AUTH) {

package/lib/tasks/requirements/dependency/centos.js

@@ -5,7 +5,7 @@ const installDependenciesTask = require('../../../util/install-dependencies-task
 /**
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
-const fedoraDependenciesCheck = () => ({
+const centosDependenciesCheck = () => ({
     title: 'Checking CentOS dependencies',
     task: async (ctx, task) => {
         const installedDependencies = (await execAsyncSpawn('yum list installed')).split('\n')
@@ -32,4 +32,4 @@ const fedoraDependenciesCheck = () => ({
     }
 });
 
-module.exports = fedoraDependenciesCheck;
+module.exports = centosDependenciesCheck;

package/lib/tasks/requirements/dependency/index.js

@@ -1,4 +1,3 @@
-const os = require('os');
 const osPlatform = require('../../../util/os-platform');
 const archDependenciesCheck = require('./arch');
 const fedoraDependenciesCheck = require('./fedora');
@@ -7,9 +6,7 @@ const ubuntuDependenciesCheck = require('./ubuntu');
 const macDependenciesCheck = require('./mac');
 
 const dependencyCheck = async () => {
-    const currentPlatform = os.platform();
-
-    if (currentPlatform === 'darwin') {
+    if (process.platform === 'darwin') {
         return macDependenciesCheck();
     }
 

package/lib/tasks/requirements/docker/index.js

@@ -9,7 +9,7 @@ const getDockerVersion = require('./version');
  * @type {() => import('listr2').ListrTask<import('../../../../typings/context').ListrContext>}
  */
 const checkDocker = () => ({
-    title: 'Checking docker',
+    title: 'Checking Docker',
     task: async (ctx, task) => {
         const { code } = await execAsyncSpawn('docker -v', {
             withCode: true
@@ -63,7 +63,7 @@ ${ logger.style.link('https://docs.create-magento-app.com/getting-started/prereq
             getDockerVersion(),
             {
                 task: (ctx) => {
-                    task.title = `Using docker version ${ctx.dockerVersion}`;
+                    task.title = `Using Docker version ${ctx.dockerVersion}`;
                 }
             }
         ]);

package/lib/util/config-file-validator.js

@@ -83,7 +83,13 @@ const serviceConfigurationSchema = Joi.object({
  * @type {Joi.ObjectSchema<import('../../typings').CMAConfiguration['configuration']['composer']>}
  */
 const composerConfigurationSchema = Joi.object({
-    version: Joi.string().optional().allow('1', '2')
+    version: Joi.string().optional().custom((value) => {
+        if (['1', '2'].includes(value)) {
+            return undefined;
+        }
+
+        return versionValidator(value);
+    })
 });
 
 /**

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": "1.11.3",
+    "version": "1.12.2",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -27,6 +27,7 @@
         "enquirer": "2.3.6",
         "eta": "1.12.3",
         "getos": "3.2.1",
+        "hjson": "^3.2.2",
         "is-installed-globally": "0.4.0",
         "joi": "17.4.2",
         "listr2": "3.13.0",
@@ -41,5 +42,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "65ce8d3707c624de570a0f39c1ba890fe736554b"
+    "gitHead": "8e4db94149d0d2b56fef23f6c9db8c0df223da2e"
 }

package/typings/context.d.ts

@@ -1,4 +1,4 @@
-import { CMAConfiguration, PHPExtension } from './index';
+import { CMAConfiguration, PHPExtensions } from './index';
 
 export interface ListrContext {
     magentoVersion: string
@@ -29,7 +29,7 @@ export interface ListrContext {
             fpmBinPath: string
             fpmConfPath: string
             fpmPidFilePath: string
-            extensions: PHPExtension
+            extensions: PHPExtensions
             version: string
         }
         composer: {

package/typings/index.d.ts

@@ -1,3 +1,7 @@
+import { ListrTaskWrapper } from 'listr2';
+
+import { ListrContext } from './context';
+
 /* eslint-disable no-use-before-define */
 export interface ServiceWithVersion {
     /**
@@ -37,11 +41,40 @@ export interface PHPExtension extends Record<string, unknown> {
      * }
      * ```
      */
+    linuxOptions?: string
+    macosOptions?: string
     extensionName?: string
     hooks?: {
-        preInstall: (config: CMAConfiguration['configuration']) => Promise<void>
-        postInstall: (config: CMAConfiguration['configuration']) => Promise<void>
+        preEnable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
+        postEnable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
+        preDisable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
+        postDisable?: (config: CMAConfiguration['configuration']) => Promise<void> | void
+        preInstall?: (config: CMAConfiguration['configuration']) => Promise<void> | void
+        postInstall?: (config: CMAConfiguration['configuration']) => Promise<void> | void
     }
+    /**
+     * Allow to define custom logic to install extension
+     */
+    install?: (
+        ctx: ListrContext,
+        task: ListrTaskWrapper<ListrContext, any>
+    ) => Promise<void> | void
+
+    /**
+     * Allow to define custom logic to enable an extension
+     */
+    enable?: (
+        ctx: ListrContext,
+        task: ListrTaskWrapper<ListrContext, any>
+    ) => Promise<void> | void
+
+    /**
+     * Allow to define custom logic to disable an extension
+     */
+    disable?: (
+        ctx: ListrContext,
+        task: ListrTaskWrapper<ListrContext, any>
+    ) => Promise<void> | void
 }
 
 export interface PHPExtensions {
@@ -54,6 +87,7 @@ export interface PHPExtensions {
     xdebug: PHPExtension
     fileinfo: PHPExtension
     libsodium: PHPExtension
+    [key: string]: PHPExtension
 }
 
 export interface PHPConfiguration {