@scandipwa/magento-scripts 2.4.11 → 2.4.12

package/lib/tasks/status/index.js

@@ -8,6 +8,16 @@ const { getArchSync } = require('../../util/arch')
 const ConsoleBlock = require('../../util/console-block')
 const { getInstanceMetadata } = require('../../util/instance-metadata')
 
+// eslint-disable-next-line no-control-regex
+const consoleStyleReplacer = /[]\[\S+?m/g
+
+/**
+ * chalk already drops styling when stdout is not a TTY, but strip defensively
+ * so the plain output stays clean even under FORCE_COLOR.
+ * @param {string} str
+ */
+const stripStyle = (str) => String(str).replace(consoleStyleReplacer, '')
+
 /**
  * @param {any} str
  * @returns {str is string}
@@ -230,9 +240,10 @@ const prettyStatus = async (ctx) => {
 
     Object.values(volumes)
         .map((volume) => {
-            volume.volumeData = systemDFData.Volumes.find(
-                (v) => v.Name === volume.name
-            )
+            volume.volumeData =
+                systemDFData &&
+                systemDFData.Volumes &&
+                systemDFData.Volumes.find((v) => v.Name === volume.name)
 
             return volume
         })
@@ -273,4 +284,174 @@ const prettyStatus = async (ctx) => {
     block.log()
 }
 
-module.exports = { prettyStatus }
+/**
+ * Plain-text status summary for non-interactive environments (AI agents, CI,
+ * pipes). No box drawing or ANSI styling — just the facts an agent needs to
+ * act, plus the commands to run next.
+ * @param {import('../../../typings/context').ListrContext & { containers: ReturnType<Awaited<ReturnType<import('../../config/docker')>>['getContainers']> }} ctx
+ */
+const simpleStatus = (ctx) => {
+    const {
+        config: { baseConfig },
+        magentoVersion,
+        composerVersion,
+        dockerVersion,
+        containers,
+        systemDFData,
+        verbose
+    } = ctx
+
+    const lines = []
+
+    lines.push(
+        `magento-scripts ${packageVersion} — status (non-interactive)`,
+        '',
+        `Project: ${baseConfig.prefix}`,
+        `Location: ${process.cwd()}`,
+        `Magento: ${magentoVersion || 'unknown'}`,
+        `PHP: ${ctx.phpVersion || 'unknown'}`,
+        `Composer: ${composerVersion || 'unknown'}`,
+        `Docker: ${dockerVersion || 'unknown'}`,
+        `Platform: ${ctx.platform} (${getArchSync()})`
+    )
+
+    lines.push(
+        `Platform version: ${ctx.platformVersion || 'unknown'}`,
+        `CGroup version: ${ctx.cgroupVersion || 'unknown'}`
+    )
+
+    const projectCreatedAt = getProjectCreatedAt()
+    if (projectCreatedAt) {
+        lines.push(
+            `Project created: ${projectCreatedAt.toDateString()} ${projectCreatedAt.toTimeString()}`
+        )
+    }
+
+    lines.push('', 'Containers:')
+
+    let anyRunning = false
+
+    Object.values(containers).forEach((container) => {
+        const state = container.status && container.status.State
+        let status
+
+        if (state && state.Health && state.Status === 'running') {
+            status = `running (${state.Health.Status})`
+            anyRunning = true
+        } else if (state && state.Status && state.Status !== 'exited') {
+            status = state.Status
+            if (state.Status === 'running') {
+                anyRunning = true
+            }
+        } else {
+            status = 'not running'
+        }
+
+        lines.push(`  ${container._ || container.name}: ${status}`)
+
+        lines.push(`    Name: ${container.name}`)
+
+        const image =
+            container.status &&
+            container.status.Config &&
+            container.status.Config.Image
+                ? container.status.Config.Image
+                : container.image
+        lines.push(`    Image: ${image}`, `    Network: ${container.network}`)
+
+        if (
+            status !== 'not running' &&
+            container.forwardedPorts &&
+            container.forwardedPorts.length > 0
+        ) {
+            lines.push('    Port forwarding:')
+            container.forwardedPorts.forEach((port) => {
+                const { host, hostPort, containerPort } = parsePort(port)
+                if (container.network !== 'host') {
+                    lines.push(
+                        `      ${host}:${hostPort} -> ${containerPort} (host -> container)`
+                    )
+                } else {
+                    lines.push(
+                        `      Running on host network - ${host}:${hostPort}`
+                    )
+                }
+            })
+        }
+
+        if (container.env && Object.keys(container.env).length > 0) {
+            lines.push('    Environment variables:')
+            for (const [envName, envValue] of Object.entries(container.env)) {
+                lines.push(`      ${envName}=${envValue}`)
+            }
+        }
+
+        if (container.description) {
+            lines.push('    Description:')
+            container.description.split('\n').forEach((line) => {
+                lines.push(`      ${stripStyle(line)}`)
+            })
+        }
+    })
+
+    lines.push('', 'Volumes:')
+
+    const { volumes } = ctx.config.docker
+
+    Object.values(volumes).forEach((volume) => {
+        const volumeData =
+            systemDFData &&
+            systemDFData.Volumes &&
+            systemDFData.Volumes.find((v) => v.Name === volume.name)
+
+        lines.push(`  ${volume.name}`)
+
+        if (volumeData) {
+            lines.push(`    Size: ${volumeData.Size}`)
+        }
+
+        if (ctx.isDockerDesktop && volume.opt && volume.opt.device) {
+            lines.push(
+                `    Mountpoint: ${volume.opt.device.replace(
+                    process.cwd(),
+                    '<project location>'
+                )}`
+            )
+        }
+    })
+
+    if (!verbose) {
+        lines.push('  (volume sizes omitted — pass --verbose to include them)')
+    }
+
+    const instanceMetadata = getInstanceMetadata(ctx)
+
+    lines.push('', 'Frontend:')
+    instanceMetadata.frontend.forEach(({ title, text }) => {
+        lines.push(`  ${stripStyle(title)}: ${stripStyle(text)}`)
+    })
+
+    lines.push('', 'Admin:')
+    instanceMetadata.admin.forEach(({ title, text }) => {
+        lines.push(`  ${stripStyle(title)}: ${stripStyle(text)}`)
+    })
+
+    lines.push('', 'MailDev:')
+    instanceMetadata.maildev.forEach(({ title, text }) => {
+        lines.push(`  ${stripStyle(title)}: ${stripStyle(text)}`)
+    })
+
+    lines.push('')
+    if (!anyRunning) {
+        lines.push(
+            'Environment is not running. Start it with: magento-scripts start'
+        )
+    }
+    lines.push(
+        'Run Magento CLI: magento-scripts exec php bin/magento <command>'
+    )
+
+    logger.log(lines.join('\n'))
+}
+
+module.exports = { prettyStatus, simpleStatus }

package/lib/util/execute-in-container.js

@@ -30,18 +30,16 @@ const joinCommandArgs = (...args) =>
  * @param {{ containerName: string, commands: string[], user?: string, env?: Record<string, string> }} param0
  */
 const executeInContainer = ({ containerName, commands, user, env }) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode')
-        process.exit(1)
-    }
     const [commandBin, ...commandsArgs] = commands
 
+    const isTTY = process.stdin.isTTY
+
     const execArgs = execCommand({
         container: containerName,
         command: commandBin,
         user,
-        tty: true,
-        interactive: true,
+        tty: isTTY,
+        interactive: isTTY,
         env: env || {}
     })
     const [command, ...args] = execArgs
@@ -91,18 +89,14 @@ const executeInContainerNonInteractive = async ({
  * @param {string[]} commands
  */
 const runInContainer = async (options, commands) => {
-    if (!process.stdin.isTTY) {
-        process.stderr.write('This app works only in TTY mode')
-        process.exit(1)
-    }
-
+    const isTTY = process.stdin.isTTY
     const [commandBin, ...commandsArgs] = commands
 
     const runResult = await run(
         {
             ...options,
             command: joinCommandArgs(commandBin, ...commandsArgs),
-            tty: true,
+            tty: isTTY,
             detach: false,
             rm: true
         },

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.4.11",
+    "version": "2.4.12",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -59,5 +59,5 @@
         "@types/node": "^20.14.11",
         "@types/yargs": "^17.0.32"
     },
-    "gitHead": "64c177af194cf32de4d8ae08116f016d30ec7f01"
+    "gitHead": "6989fd1f8233b1586050ea39a89c1db29334f6cb"
 }

package/typings/context.d.ts

@@ -8,6 +8,7 @@ import { PHPStormConfig } from './phpstorm'
 
 export interface ListrContext {
     noOpen?: boolean
+    open?: boolean
     skipSetup?: boolean
     resetGlobalConfig?: boolean
     withCustomersData?: boolean
@@ -159,4 +160,14 @@ export interface ListrContext {
     dockerClientData?: DockerVersionResult['Client']
     dockerVersion?: DockerVersionResult['Server']['Version']
     dockerMemoryLimit: number
+    silent?: boolean
+    nonInteractive?: boolean
+    deleteDb?: 'always' | 'never' | 'ask'
+    dbUser?: 'root' | 'magento'
+    fixCollation?: 'auto' | 'never' | 'ask'
+    installMagentoEmptyDb?: 'yes' | 'no' | 'ask'
+    privateKey?: string
+    passphrase?: string
+    makeRemoteDumps?: boolean
+    remoteDumpCommand?: string
 }