@scandipwa/magento-scripts 2.4.12-alpha.0 → 2.4.12

package/index.js

@@ -6,7 +6,6 @@ const logger = require('@scandipwa/scandipwa-dev-utils/logger')
 const semver = require('semver')
 const isInstalledGlobally = require('is-installed-globally')
 const isRunningRoot = require('./lib/util/is-running-root')
-const ensureAgentsMd = require('./lib/util/ensure-agents-md')
 
 if (isRunningRoot()) {
     logger.error('Root privileges detected!')
@@ -28,8 +27,6 @@ If you are experiencing problems with ${logger.style.misc(
     process.exit(1)
 }
 
-ensureAgentsMd()
-
 const commands = [
     require('./lib/commands/link'),
     require('./lib/commands/logs'),

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,10 +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(),
@@ -40,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({
@@ -59,15 +87,25 @@ module.exports = (yargs) => {
                 {
                     concurrent: false,
                     exitOnError: false,
-                    ctx: { throwMagentoVersionMissing: true, ...args, silent },
-                    renderer:
-                        silent || !process.stdout.isTTY ? 'silent' : 'default',
+                    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/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/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.12-alpha.0",
+    "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": "0fe2409c4e619ff985cf90a7f3d6cc4d45ca2552"
+    "gitHead": "6989fd1f8233b1586050ea39a89c1db29334f6cb"
 }

package/lib/util/ensure-agents-md.js

@@ -1,79 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-
-const AGENTS_MD_CONTENT = `# CMA (magento-scripts) — AI/CI Reference
-
-> Auto-generated by magento-scripts. Do not delete.
-
-## Critical
-
-- **Cannot run as root** — exits immediately with code 1, no override.
-- **Non-TTY safe** — silent renderer activates automatically in CI/pipes; no \`-q\` needed.
-- **Do NOT use \`--\` with exec** — it gets passed as the command and fails. Correct: \`magento-scripts exec php bin/magento cache:flush\`
-- **\`cli\` is TTY-only** — use \`exec php bin/magento <cmd>\` in automation instead.
-- **\`import-db\` is self-contained** — it stops running containers, assigns ports, starts services, waits for MariaDB, and imports. Do NOT run \`start\` before or between \`import-db\` attempts — that creates port conflicts. Just run \`import-db\` directly.
-- **Do NOT run \`start\` then \`import-db\`** — each command manages its own container lifecycle. Running both creates split-brain port assignments. Use one or the other.
-- **Long-running commands** — \`start\` and \`import-db\` can take 10+ minutes (container setup, large dumps). Set timeouts to at least 600000ms (10 min) or run without a timeout.
-- **Shell escaping** — Avoid \`!\` in SQL strings passed via \`exec\` (e.g., \`!=\`), as the shell may interpret it. Use SQL alternatives like \`<>\` instead of \`!=\`.
-
-## Commands
-
-| Command | What it does | Key flags |
-|---------|-------------|-----------|
-| \`start\` | Start Docker environment | \`--no-open\`, \`--skip-setup\`, \`--port\` |
-| \`stop\` | Stop all containers | — |
-| \`status\` | Show container/DB status | — |
-| \`exec <container> [cmd...]\` | Run command in container | use \`--\` before flags |
-| \`import-db [file]\` | Import SQL dump into MariaDB | \`-y\` (non-interactive), \`--remote-db=ssh://user@host\` |
-| \`logs <container>\` | Stream container logs | \`--tail N\`, \`--follow\` |
-| \`cleanup\` | Remove cached/generated files | \`--force\` |
-| \`cli\` | Interactive shell (TTY only) | — |
-| \`link <path>\` | Link ScandiPWA theme | — |
-
-## Containers
-
-\`php\`, \`phpWithXdebug\`, \`nginx\`, \`sslTerminator\`, \`redis\`, \`mariadb\`, \`elasticsearch\`, \`maildev\`, \`varnish\` (if enabled)
-
-## Examples
-
-\`\`\`bash
-magento-scripts start --no-open --skip-setup
-magento-scripts import-db dump.sql -y
-magento-scripts import-db -y --remote-db=ssh://user@host
-magento-scripts exec php bin/magento cache:flush
-magento-scripts exec php bin/magento indexer:reindex
-
-# Query MariaDB (use mariadb binary, not mysql)
-magento-scripts exec mariadb mariadb -u magento -pmagento magento -e "SELECT COUNT(*) FROM store"
-magento-scripts logs magento --tail 100
-magento-scripts stop
-\`\`\`
-`
-
-/**
- * Write AGENTS.md and CLAUDE.md to the current working directory if they do not already exist.
- * This gives AI agents and CI pipelines a command reference for the project.
- */
-function ensureAgentsMd() {
-    const cwd = process.cwd()
-
-    const agentsDest = path.join(cwd, 'AGENTS.md')
-    if (!fs.existsSync(agentsDest)) {
-        try {
-            fs.writeFileSync(agentsDest, AGENTS_MD_CONTENT, 'utf8')
-        } catch (e) {
-            // Non-fatal — silently skip if the directory is not writable
-        }
-    }
-
-    const claudeDest = path.join(cwd, 'CLAUDE.md')
-    if (!fs.existsSync(claudeDest)) {
-        try {
-            fs.writeFileSync(claudeDest, '@AGENTS.md\n', 'utf8')
-        } catch (e) {
-            // Non-fatal
-        }
-    }
-}
-
-module.exports = ensureAgentsMd