@scandipwa/magento-scripts 2.4.11 → 2.4.12

package/index.js

@@ -123,6 +123,14 @@ const newVersionIsAPatch = (latestVersion, currentVersion) => {
     yargs.scriptName('magento-scripts')
     yargs.version(false)
 
+    yargs.option('silent', {
+        alias: 'q',
+        describe:
+            'Suppress all task progress output (Listr silent renderer). Enabled automatically when stdout is not a TTY.',
+        type: 'boolean',
+        default: false
+    })
+
     // Initialize program commands
     commands.forEach((command) => command(yargs))
 

package/lib/commands/cleanup.js

@@ -18,12 +18,16 @@ module.exports = (yargs) => {
             }),
         async (args) => {
             logger.warn('you should not use this command.')
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(cleanup(), {
                 concurrent: false,
                 exitOnError: true,
                 ctx: {
-                    force: args.force
+                    force: args.force,
+                    silent
                 },
+                renderer:
+                    silent || !process.stdout.isTTY ? 'silent' : 'default',
                 rendererOptions: { collapse: false }
             })
 

package/lib/commands/cli.js

@@ -20,7 +20,8 @@ module.exports = (yargs) => {
         'Enter CLI (magento, php, composer).',
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {},
-        async () => {
+        async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(
                 [
                     getMagentoVersionConfig(),
@@ -33,8 +34,11 @@ module.exports = (yargs) => {
                     concurrent: false,
                     exitOnError: true,
                     ctx: {
-                        throwMagentoVersionMissing: true
+                        throwMagentoVersionMissing: true,
+                        silent
                     },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: true }
                 }
             )

package/lib/commands/import-db.js

@@ -27,12 +27,25 @@ module.exports = (yargs) => {
                 type: 'boolean',
                 default: false
             })
+            yargs.option('non-interactive', {
+                alias: 'y',
+                describe:
+                    'Skip all interactive prompts using sensible defaults',
+                type: 'boolean',
+                default: false
+            })
         },
         async (args) => {
             const tasks = new Listr(importDump(), {
                 exitOnError: true,
                 ctx: args,
                 concurrent: false,
+                renderer:
+                    /** @type {boolean} */ (args.silent) ||
+                    /** @type {boolean} */ (args.nonInteractive) ||
+                    !process.stdout.isTTY
+                        ? 'silent'
+                        : 'default',
                 rendererOptions: {
                     showErrorMessage: false,
                     showTimer: true

package/lib/commands/link.js

@@ -17,12 +17,18 @@ module.exports = (yargs) => {
                 default: false
             }),
         async (args) => {
-            const tasks = new Listr(linkTask(args.themepath), {
-                concurrent: false,
-                exitOnError: true,
-                ctx: { throwMagentoVersionMissing: true },
-                rendererOptions: { collapse: false }
-            })
+            const silent = /** @type {boolean} */ (args.silent)
+            const tasks = new Listr(
+                linkTask(/** @type {string} */ (args.themepath)),
+                {
+                    concurrent: false,
+                    exitOnError: true,
+                    ctx: { throwMagentoVersionMissing: true, silent },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
+                    rendererOptions: { collapse: false }
+                }
+            )
 
             try {
                 await tasks.run()

package/lib/commands/logs.js

@@ -70,6 +70,7 @@ npm run logs re (will match redis)`)
             })
         },
         async (argv) => {
+            const silent = /** @type {boolean} */ (argv.silent)
             const tasks = new Listr(
                 [
                     checkRequirements(),
@@ -82,7 +83,12 @@ npm run logs re (will match redis)`)
                 {
                     concurrent: false,
                     exitOnError: true,
-                    ctx: { throwMagentoVersionMissing: true },
+                    ctx: {
+                        throwMagentoVersionMissing: true,
+                        silent
+                    },
+                    renderer:
+                        silent || !process.stdout.isTTY ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: true }
                 }
             )

package/lib/commands/start.js

@@ -64,9 +64,9 @@ module.exports = (yargs) => {
                     type: 'number',
                     nargs: 1
                 })
-                .option('no-open', {
+                .option('open', {
                     alias: 'n',
-                    describe: 'Do not open browser after command finished',
+                    describe: 'Open browser after command finished',
                     type: 'boolean',
                     default: false
                 })
@@ -109,6 +109,11 @@ module.exports = (yargs) => {
                 exitOnError: true,
                 ctx: args,
                 concurrent: false,
+                renderer:
+                    /** @type {boolean} */ (args.silent) ||
+                    !process.stdout.isTTY
+                        ? 'silent'
+                        : 'default',
                 rendererOptions: {
                     showErrorMessage: false,
                     showTimer: true

package/lib/commands/status.js

@@ -3,7 +3,7 @@ const { Listr } = require('listr2')
 const getMagentoVersionConfig = require('../config/get-magento-version-config')
 const { getCachedPorts } = require('../config/get-port-config')
 
-const { prettyStatus } = require('../tasks/status')
+const { prettyStatus, simpleStatus } = require('../tasks/status')
 const { checkRequirements } = require('../tasks/requirements')
 const { statusContainers } = require('../tasks/docker/containers')
 const getProjectConfiguration = require('../config/get-project-configuration')
@@ -20,9 +20,35 @@ module.exports = (yargs) => {
     yargs.command(
         'status',
         'Show application status',
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        () => {},
+        (yargs) => {
+            yargs
+                .option('non-interactive', {
+                    alias: 'n',
+                    type: 'boolean',
+                    default: false,
+                    description:
+                        'Print a plain-text status summary (for AI terminals and scripts)'
+                })
+                .option('verbose', {
+                    alias: 'v',
+                    type: 'boolean',
+                    default: false,
+                    description:
+                        'Retrieve Docker image and volume sizes (slower, off by default)'
+                })
+        },
         async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
+            // A non-TTY stdout (pipe, CI, AI terminal) is inherently
+            // non-interactive; the -n flag forces it even inside a TTY.
+            const nonInteractive =
+                !!(args.nonInteractive || args.n) || !process.stdout.isTTY
+            // Enumerating per-image/-volume sizes shells out to
+            // `docker system df --verbose`, which is slow; skip it by default.
+            // The non-interactive report already prints the full status; the
+            // --verbose flag only adds the Docker image/volume sizes (and is
+            // what the pretty renderer needs to render them at all).
+            const verbose = !!(args.verbose || args.v)
             const tasks = new Listr(
                 [
                     checkRequirements(),
@@ -39,6 +65,9 @@ module.exports = (yargs) => {
                                     checkSearchEngineVersion(),
                                     {
                                         title: 'Retrieving Docker System data',
+                                        skip: () =>
+                                            !verbose &&
+                                            'Docker image and volume sizes omitted (pass --verbose to include them)',
                                         task: async (ctx) => {
                                             ctx.systemDFData =
                                                 await systemApi.df({
@@ -58,13 +87,25 @@ module.exports = (yargs) => {
                 {
                     concurrent: false,
                     exitOnError: false,
-                    ctx: { throwMagentoVersionMissing: true, ...args },
+                    ctx: {
+                        throwMagentoVersionMissing: true,
+                        ...args,
+                        silent,
+                        nonInteractive,
+                        verbose
+                    },
+                    renderer: silent || nonInteractive ? 'silent' : 'default',
                     rendererOptions: { collapse: false, clearOutput: false }
                 }
             )
 
             try {
-                await prettyStatus(await tasks.run())
+                const ctx = await tasks.run()
+                if (nonInteractive) {
+                    simpleStatus(ctx)
+                } else {
+                    await prettyStatus(ctx)
+                }
             } catch (e) {
                 logger.error(e.message || e)
                 process.exit(1)

package/lib/commands/stop.js

@@ -10,16 +10,20 @@ module.exports = (yargs) => {
         'Stop the application.',
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {},
-        async () => {
+        async (args) => {
+            const silent = /** @type {boolean} */ (args.silent)
             const tasks = new Listr(stop(), {
                 concurrent: false,
                 exitOnError: true,
-                rendererOptions: {
-                    collapse: false
-                },
                 ctx: {
                     throwMagentoVersionMissing: true,
-                    projectPath: process.cwd()
+                    projectPath: process.cwd(),
+                    silent
+                },
+                renderer:
+                    silent || !process.stdout.isTTY ? 'silent' : 'default',
+                rendererOptions: {
+                    collapse: false
                 }
             })
 

package/lib/config/check-configuration-file.js

@@ -49,13 +49,15 @@ const checkConfigurationFile = () => ({
             }
 
             if (!magentoConfiguration) {
-                const magentoEdition = await task.prompt({
-                    type: 'Select',
-                    message: `Please select Magento edition you want to install.
+                const magentoEdition = ctx.nonInteractive
+                    ? 'Community'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `Please select Magento edition you want to install.
 
 Note that Enterprise edition requires Magento Enterprise License keys.`,
-                    choices: ['Community', 'Enterprise']
-                })
+                          choices: ['Community', 'Enterprise']
+                      })
 
                 magentoConfiguration = deepmerge(defaultMagentoConfig, {
                     edition: magentoEdition.toLowerCase()

package/lib/config/docker.js

@@ -232,7 +232,8 @@ module.exports = async (ctx, overridenConfiguration, baseConfig) => {
                 name: `${prefix}_php_with_xdebug`,
                 connectCommand: ['/bin/sh'],
                 execCommandEnv: {
-                    XDEBUG_TRIGGER: 'PHPSTORM'
+                    XDEBUG_TRIGGER: 'PHPSTORM',
+                    XDEBUG_SESSION: 'PHPSTORM'
                 },
                 dependsOn: ['mariadb', 'redis', 'elasticsearch'],
                 user:

package/lib/config/get-magento-version-config.js

@@ -48,6 +48,8 @@ const getMagentoVersion = () => ({
                     const { magentoVersion: defaultMagentoVersion } =
                         defaultConfiguration
                     magentoVersion = defaultMagentoVersion
+                } else if (ctx.nonInteractive) {
+                    magentoVersion = defaultConfiguration.magento
                 } else {
                     let promptSkipper = false
                     const timer = async () => {

package/lib/tasks/database/create-magento-user.js

@@ -1,4 +1,5 @@
 const mysql2 = require('mysql2/promise')
+const sleep = require('../../util/sleep')
 const defaultMagentoUser = require('./default-magento-user')
 
 /**
@@ -8,12 +9,31 @@ const createMagentoUser = () => ({
     title: 'Creating Magento user',
     task: async (ctx, task) => {
         const { mariadb } = ctx.config.docker.getContainers()
-        const connection = await mysql2.createConnection({
-            host: '127.0.0.1',
-            port: ctx.ports.mariadb,
-            user: 'root',
-            password: mariadb.env.MARIADB_ROOT_PASSWORD
-        })
+
+        /** @type {import('mysql2/promise').Connection | undefined} */
+        let connection
+        const maxTries = 20
+
+        for (let tries = 1; tries <= maxTries; tries++) {
+            try {
+                connection = await mysql2.createConnection({
+                    host: '127.0.0.1',
+                    port: ctx.ports.mariadb,
+                    user: 'root',
+                    password: mariadb.env.MARIADB_ROOT_PASSWORD
+                })
+                break
+            } catch (e) {
+                if (tries === maxTries) {
+                    throw e
+                }
+                await sleep(1000)
+            }
+        }
+
+        if (!connection) {
+            throw new Error('Failed to connect to MariaDB')
+        }
 
         const result = await connection.query(
             'select Host, User from mysql.user;'

package/lib/tasks/database/fix-db.js

@@ -36,11 +36,13 @@ const fixDB = () => ({
                     title: 'Deleting customers data',
                     skip: ({ withCustomersData }) => withCustomersData,
                     task: async (ctx, subTask) => {
-                        const deleteCustomerData = await subTask.prompt({
-                            type: 'Confirm',
-                            message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
+                        const deleteCustomerData = ctx.nonInteractive
+                            ? false
+                            : await subTask.prompt({
+                                  type: 'Confirm',
+                                  message: `Do you want to delete customers data (orders, customers and admin users) from this dump?
 This will reduce database size and remove possible interference for your setup.`
-                        })
+                              })
 
                         if (!deleteCustomerData) {
                             subTask.skip()

package/lib/tasks/database/import-dump-to-database.js

@@ -60,25 +60,27 @@ const runSetGlobalLogBinTrustFunctionCreatorsCommand = () => ({
 const deleteDatabaseBeforeImportingDumpPrompt = () => ({
     title: 'Deleting magento database before importing dump',
     task: async (ctx, task) => {
-        const deleteDatabaseMagentoChoice = await task.prompt({
-            type: 'Select',
-            message: `Before importing database dump, would you like to delete existing database?
+        const deleteDatabaseMagentoChoice = ctx.nonInteractive
+            ? 'delete'
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Before importing database dump, would you like to delete existing database?
 
 It is possible that dump might interfere with existing data in database.
 
 Note that you will lose your existing database!`,
-            choices: [
-                {
-                    name: 'delete',
-                    message: 'YES I WANT TO DELETE magento DATABASE!'
-                },
-                {
-                    name: 'skip',
-                    message:
-                        "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
-                }
-            ]
-        })
+                  choices: [
+                      {
+                          name: 'delete',
+                          message: 'YES I WANT TO DELETE magento DATABASE!'
+                      },
+                      {
+                          name: 'skip',
+                          message:
+                              "NO I DON'T WANT TO DELETE magento DATABASE! (Skip this step)"
+                      }
+                  ]
+              })
 
         if (deleteDatabaseMagentoChoice === 'delete') {
             await ctx.databaseConnection.query(
@@ -103,22 +105,24 @@ const executeImportDumpSQL = () => ({
         const { mariadb } = docker.getContainers(ports)
         const { binFileName } = overridenConfiguration.configuration.mariadb
 
-        const userCredentialsForMariaDBCLI = await task.prompt({
-            type: 'Select',
-            message: `Which user do you want to use to import db in ${mariadb._} client?`,
-            choices: [
-                {
-                    name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
-                    message: `root (${logger.style.command(
-                        'Probably safest option'
-                    )})`
-                },
-                {
-                    name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
-                    message: `${defaultMagentoUser.user}`
-                }
-            ]
-        })
+        const userCredentialsForMariaDBCLI = ctx.nonInteractive
+            ? `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`
+            : await task.prompt({
+                  type: 'Select',
+                  message: `Which user do you want to use to import db in ${mariadb._} client?`,
+                  choices: [
+                      {
+                          name: `--user=root --password=${mariadb.env.MARIADB_ROOT_PASSWORD}`,
+                          message: `root (${logger.style.command(
+                              'Probably safest option'
+                          )})`
+                      },
+                      {
+                          name: `--user=${defaultMagentoUser.user} --password=${defaultMagentoUser.password}`,
+                          message: `${defaultMagentoUser.user}`
+                      }
+                  ]
+              })
 
         const importCommand = `docker exec ${mariadb.name} bash -c "${binFileName} ${userCredentialsForMariaDBCLI} magento < ./dump.sql"`
 
@@ -137,11 +141,13 @@ const executeImportDumpSQL = () => ({
             })
         } catch (e) {
             if (e.message.includes("Unknown collation: 'utf8mb4_0900_ai_ci'")) {
-                const confirmFixingCollation = await task.prompt({
-                    type: 'Select',
-                    message: `We got the following error while trying to import ${logger.style.file(
-                        'dump.sql'
-                    )}!
+                const confirmFixingCollation = ctx.nonInteractive
+                    ? 'yes'
+                    : await task.prompt({
+                          type: 'Select',
+                          message: `We got the following error while trying to import ${logger.style.file(
+                              'dump.sql'
+                          )}!
 
 ${e.message}
 
@@ -150,18 +156,19 @@ ${logger.style.command(
     "sed -i 's/utf8mb4_0900_ai_ci/utf8mb4_general_ci/g' dump.sql"
 )}
 `,
-                    choices: [
-                        {
-                            name: 'yes',
-                            message:
-                                'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
-                        },
-                        {
-                            name: 'no',
-                            message: 'Okay, I got it. Will try to fix myself'
-                        }
-                    ]
-                })
+                          choices: [
+                              {
+                                  name: 'yes',
+                                  message:
+                                      'Yes, run the following commands, I reaaaalllyy want dump to work! (this will not edit original dump.sql)'
+                              },
+                              {
+                                  name: 'no',
+                                  message:
+                                      'Okay, I got it. Will try to fix myself'
+                              }
+                          ]
+                      })
 
                 if (confirmFixingCollation === 'yes') {
                     task.output = 'Running fix command...'

package/lib/tasks/database/import-remote-db/ssh/index.js

@@ -19,11 +19,13 @@ const sshDb = () => ({
         ctx.ssh = ssh
 
         if (!password) {
-            const privateKey = await task.prompt({
-                type: 'Input',
-                message: `Please enter your private key location to connect to ${hostname}\n`,
-                initial: `${os.homedir()}/.ssh/id_rsa`
-            })
+            const privateKey = ctx.nonInteractive
+                ? `${os.homedir()}/.ssh/id_rsa`
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Please enter your private key location to connect to ${hostname}\n`,
+                      initial: `${os.homedir()}/.ssh/id_rsa`
+                  })
 
             if (!(await pathExists(privateKey))) {
                 throw new KnownError(`Private key not found: ${privateKey}`)
@@ -31,11 +33,13 @@ const sshDb = () => ({
 
             ctx.privateKey = privateKey
 
-            const passphrase = await task.prompt({
-                type: 'Input',
-                message:
-                    'Please enter your private key passphrase (if you have it)'
-            })
+            const passphrase = ctx.nonInteractive
+                ? undefined
+                : await task.prompt({
+                      type: 'Input',
+                      message:
+                          'Please enter your private key passphrase (if you have it)'
+                  })
 
             ctx.passphrase = passphrase || undefined
 
@@ -67,14 +71,16 @@ const sshDb = () => ({
         const remoteFiles = remoteFilesOutput.split('\n')
 
         if (dumpFileNames.every((dumpFile) => remoteFiles.includes(dumpFile))) {
-            ctx.makeRemoteDumps = await task.prompt({
-                type: 'Toggle',
-                enabled: 'Yes!',
-                disabled: 'No, just download and import them.',
-                message: `We found dump files on remote server.
+            ctx.makeRemoteDumps = ctx.nonInteractive
+                ? true
+                : await task.prompt({
+                      type: 'Toggle',
+                      enabled: 'Yes!',
+                      disabled: 'No, just download and import them.',
+                      message: `We found dump files on remote server.
   Do you want to replace them with new dump files or use existing ones?
 `
-            })
+                  })
         } else {
             ctx.makeRemoteDumps = true
         }

package/lib/tasks/database/import-remote-db/ssh/regular-server.js

@@ -20,15 +20,17 @@ const regularSSHServer = () => ({
             /**
              * @type {string}
              */
-            const dumpCommand = await task.prompt({
-                type: 'Input',
-                message: `Edit (if needed) command to connect to remote mysql server and create dump files.
+            const dumpCommand = ctx.nonInteractive
+                ? databaseDumpCommandWithOptions.join(' ')
+                : await task.prompt({
+                      type: 'Input',
+                      message: `Edit (if needed) command to connect to remote mysql server and create dump files.
 Do not enter "--result-file" option, we need to control that part.
 
 (documentation reference available here: https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html)
 `,
-                initial: databaseDumpCommandWithOptions.join(' ')
-            })
+                      initial: databaseDumpCommandWithOptions.join(' ')
+                  })
 
             if (dumpCommand.includes('--result-file')) {
                 throw new KnownError(

package/lib/tasks/execute.js

@@ -38,12 +38,9 @@ const executeTask = async (argv) => {
         {
             concurrent: false,
             exitOnError: true,
-            ctx: /** @type {any} */ ({ throwMagentoVersionMissing: true }),
-            renderer: nonInteractive
-                ? 'silent'
-                : process.stdout.isTTY
-                ? 'default'
-                : 'silent',
+            ctx: { throwMagentoVersionMissing: true, nonInteractive },
+            renderer:
+                nonInteractive || !process.stdout.isTTY ? 'silent' : 'default',
             rendererOptions: { collapse: false, clearOutput: true }
         }
     )