@scandipwa/magento-scripts 1.13.5-alpha.1 → 1.14.1-alpha.1

package/lib/tasks/requirements/composer.js

@@ -1,36 +1,228 @@
+const path = require('path');
+const fs = require('fs');
+const os = require('os');
 const logger = require('@scandipwa/scandipwa-dev-utils/logger');
+const pathExists = require('../../util/path-exists');
+
+const authJsonPath = path.join(process.cwd(), 'auth.json');
+const shellName = process.env.SHELL.split('/').pop();
+const shellConfigFileName = `.${shellName}rc`;
+const shellConfigFilePath = path.join(os.homedir(), shellConfigFileName);
+
+const pasteKeybinding = process.platform === 'darwin' ? 'CMD + V' : 'CTRL + SHIFT + V';
+
+const MISSING_COMPOSER_AUTH_ENV = 'missing composer auth environment variable';
+const MISSING_AUTH_JSON = 'missing auth.json file';
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
-const checkComposer = () => ({
-    title: 'Checking Composer environmental variables',
-    task: () => {
-        try {
-            if (!process.env.COMPOSER_AUTH) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } is not set.`);
+const configureComposerCredentials = () => ({
+    title: 'Configuring Composer Credentials',
+    task: async (ctx, task) => {
+        const configureLocation = await task.prompt({
+            type: 'Select',
+            message: `We didn't find Composer credentials in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable or in your ${ logger.style.file('./auth.json') } file.
+
+Those credentials are required to install Magento.
+
+Where do you want to store them?`,
+            choices: [
+                {
+                    message: `Inside my projects directory in ${ logger.style.file('auth.json') } file [${ logger.style.misc('Recommended') }]`,
+                    name: 'auth.json'
+                },
+                {
+                    message: `Inside my shells configuration file located in users home directory ${ logger.style.file(shellConfigFileName) } [${ logger.style.misc('Shared credentials, not recommended') }] `,
+                    name: 'shell'
+                }
+            ]
+        });
+
+        const usernameCredentials = await task.prompt({
+            type: 'Input',
+            message: `Please enter your username key.
+
+You can obtain this key from Magento Marketplace
+
+1. Go to ${ logger.style.link('https://marketplace.magento.com/customer/accessKeys/') }
+2. Use created Access Keypair or click ${ logger.style.misc('Generate Access Keypair') } to generate new Access Keypair
+3. Click ${ logger.style.misc('Copy') } on ${ logger.style.misc('Public key') } and paste it here (${logger.style.misc(pasteKeybinding)})
+
+${ logger.style.misc('Username') } (${ logger.style.misc('Public key') }):`,
+            required: true,
+            validate: (value) => {
+                if (value.trim() === '') {
+                    return 'Username must not be empty';
+                }
+
+                return true;
             }
+        });
 
-            let magento;
+        const passwordCredentials = await task.prompt({
+            type: 'Input',
+            message: `Please enter your password key.
 
-            try {
-                magento = JSON.parse(process.env.COMPOSER_AUTH);
-            } catch (e) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } is not valid JSON.`);
+You can obtain this key from Magento Marketplace
+
+1. Go to ${ logger.style.link('https://marketplace.magento.com/customer/accessKeys/') }
+2. Use created Access Keypair or click ${ logger.style.misc('Generate Access Keypair') } to generate new Access Keypair
+3. Click ${ logger.style.misc('Copy') } on ${ logger.style.misc('Private key') } and paste it here (${logger.style.misc(pasteKeybinding)})
+
+${ logger.style.comment('Make sure to use Private key from the same Keypair as your Public key!')}
+
+${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
+            required: true,
+            validate: (value) => {
+                if (value.trim() === '') {
+                    return 'Password must not be empty';
+                }
+
+                return true;
             }
+        });
 
-            if (!magento || !magento['http-basic'] || !magento['http-basic']['repo.magento.com']) {
-                throw new Error(`Environmental variable ${ logger.style.misc('COMPOSER_AUTH') } does not contain the ${ logger.style.misc('repo.magento.com') } field.`);
+        const authContent = {
+            'http-basic': {
+                'repo.magento.com': {
+                    username: usernameCredentials,
+                    password: passwordCredentials
+                }
             }
-        } catch (e) {
+        };
+
+        const authJsonContent = JSON.stringify(authContent, null, 4);
+        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(authContent)}'`;
+
+        process.env.COMPOSER_AUTH = authJsonContent;
+
+        if (configureLocation === 'auth.json') {
+            await fs.promises.writeFile(authJsonPath, authJsonContent, 'utf-8');
+            return;
+        }
+
+        switch (shellName) {
+        case 'bash':
+        case 'zsh': {
+            await fs.promises.appendFile(
+                path.join(os.homedir(), shellConfigFileName),
+                `\n${authEnvContent}\n`
+            );
+            break;
+        }
+        default: {
             throw new Error(
-                `To generate Composer credentials login into Magento Marketplace and follow the official guide.
-        The guide is found here: ${ logger.style.link('https://devdocs.magento.com/guides/v2.3/install-gde/prereq/connect-auth.html') }
-        Then, insert obtained credentials into this command, and execute:
-        ${logger.style.code('export COMPOSER_AUTH=\'{"http-basic":{"repo.magento.com": {"username": "<PUBLIC KEY FROM MAGENTO MARKETPLACE>", "password": "<PRIVATE KEY FROM MAGENTO MARKETPLACE>"}}}\'')}\n\n${e}`
+                `Unfortunately we cannot automatically add credentials for your shell ${process.env.SHELL}!
+
+You will need to that manually!
+
+Add following string to your shell configuration file: ${ logger.style.code()}`
             );
         }
+        }
+
+        await task.prompt({
+            type: 'Confirm',
+            message: `Before we continue with installation...
+
+You selected to add your Magento credentials to your shell environment, you should know that shell configuration does not update automatically.
+
+To update it you can either restart your existing shell or run the following command to update the configuration temporarily: ${ logger.style.code('source <path/to/config/file>')}
+
+Press ${ logger.style.misc('Y') } to continue`
+        });
+    }
+});
+
+/**
+ * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ */
+const checkComposerCredentials = () => ({
+    title: 'Checking Composer credentials',
+    task: async (ctx, task) => {
+        const problems = new Map();
+        if (!process.env.COMPOSER_AUTH) {
+            problems.set(MISSING_COMPOSER_AUTH_ENV, true);
+        }
+
+        if (!await pathExists(authJsonPath)) {
+            problems.set(MISSING_AUTH_JSON, true);
+        }
+
+        if (problems.has(MISSING_COMPOSER_AUTH_ENV) && problems.has(MISSING_AUTH_JSON)) {
+            let doConfigure = true;
+            if (await pathExists(shellConfigFilePath)) {
+                const rcFileContent = await fs.promises.readFile(shellConfigFilePath, 'utf-8');
+
+                const lines = rcFileContent.split('\n');
+                const composerAuthInRcFile = lines.some((line) => line.startsWith('export COMPOSER_AUTH='));
+
+                if (composerAuthInRcFile) {
+                    doConfigure = false;
+                    const loadCredentialsFrom = await task.prompt({
+                        type: 'Confirm',
+                        message: `We detected that you have ${ logger.style.misc('COMPOSER_AUTH') } environment variable set in ${ logger.style.file(shellConfigFilePath) } file,
+but we do not see this variable inside ${ logger.style.code('magento-scripts') } process.
+
+${ logger.style.misc('! Don\'t forget to reload your shell after process is finished !') }
+
+Would you like to load them now?`
+                    });
+
+                    if (loadCredentialsFrom) {
+                        const credentialsLine = lines.find((line) => line.startsWith('export COMPOSER_AUTH='));
+                        process.env.COMPOSER_AUTH = credentialsLine.replace('export COMPOSER_AUTH=', '').replace(/'/ig, '').trim();
+                        problems.delete(MISSING_COMPOSER_AUTH_ENV);
+                    }
+                }
+            }
+
+            if (doConfigure) {
+                return task.newListr(
+                    configureComposerCredentials()
+                );
+            }
+        }
+
+        let composerAuthContent;
+
+        if (!problems.has(MISSING_AUTH_JSON)) {
+            try {
+                const composerAuthFileContent = await fs.promises.readFile(authJsonPath, 'utf-8');
+
+                composerAuthContent = JSON.parse(composerAuthFileContent);
+
+                process.env.COMPOSER_AUTH = composerAuthFileContent;
+            } catch (e) {
+                throw new Error(
+                    `We found an error in your ${ logger.style.file('./auth.json') } file.
+
+Make sure that this file contains a valid JSON!
+
+You can try linting your file here: ${ logger.style.link('https://jsonformatter.curiousconcept.com/') }
+
+Error message that we got: ${e}`
+                );
+            }
+        }
+
+        if (!problems.has(MISSING_COMPOSER_AUTH_ENV) && !composerAuthContent) {
+            try {
+                composerAuthContent = JSON.parse(process.env.COMPOSER_AUTH);
+            } catch (e) {
+                throw new Error(
+                    `We found an error in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable.
+
+Make sure that this variable contains a valid JSON!
+
+You can try linting your variable here: ${ logger.style.link('https://jsonformatter.curiousconcept.com/') }
+
+Error message that we got: ${e}`
+                );
+            }
+        }
     }
 });
 
-module.exports = checkComposer;
+module.exports = checkComposerCredentials;

package/lib/tasks/requirements/index.js

@@ -4,7 +4,6 @@ const checkComposer = require('./composer');
 const checkDocker = require('./docker');
 const checkNodeVersion = require('./node-version');
 const checkPHPVersion = require('./php-version');
-const localAuthJson = require('../composer/local-auth-json');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
@@ -21,7 +20,7 @@ const checkRequirements = () => ({
         // check the Docker installation
         checkDocker(),
         // check for COMPOSER_AUTH or auth.json
-        localAuthJson(),
+        // localAuthJson(),
         checkComposer(),
         // check for Node.js version
         checkNodeVersion()

package/lib/tasks/start.js

@@ -29,6 +29,7 @@ const convertLegacyVolumes = require('./docker/convert-legacy-volumes');
 const enableMagentoComposerPlugins = require('./magento/enable-magento-composer-plugins');
 const getIsWsl = require('../util/is-wsl');
 const checkForXDGOpen = require('../util/xdg-open-exists');
+const { getInstanceMetadata, constants: { WEB_LOCATION_TITLE } } = require('../util/instance-metadata');
 
 /**
  * @type {() => import('listr2').ListrTask<import('../../typings/context').ListrContext>}
@@ -189,8 +190,11 @@ const start = () => ({
 
                     return false;
                 },
-                task: ({ ports, config: { overridenConfiguration: { host, ssl } } }) => {
-                    openBrowser(`${ssl.enabled ? 'https' : 'http'}://${host}${ssl.enabled || ports.app === 80 ? '' : `:${ports.app}`}/`);
+                task: (ctx) => {
+                    const instanceMetadata = getInstanceMetadata(ctx);
+                    const locationOnTheWeb = instanceMetadata.frontend.find(({ title }) => title === WEB_LOCATION_TITLE);
+
+                    openBrowser(locationOnTheWeb.text);
                 },
                 options: {
                     showTimer: false

package/lib/util/instance-metadata.js

@@ -70,5 +70,11 @@ const getInstanceMetadata = (ctx) => {
 };
 
 module.exports = {
-    getInstanceMetadata
+    getInstanceMetadata,
+    constants: {
+        WEB_LOCAL_LOCATION_TITLE,
+        WEB_LOCATION_TITLE,
+        WEB_ADMIN_LOCATION_TITLE,
+        WEB_ADMIN_CREDENTIALS_TITLE
+    }
 };

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.13.5-alpha.1",
+    "version": "1.14.1-alpha.1",
     "main": "./index.js",
     "types": "./typings/index.d.ts",
     "license": "OSL-3.0",
@@ -26,6 +26,7 @@
         "conf": "10.1.1",
         "enquirer": "2.3.6",
         "eta": "1.12.3",
+        "fast-xml-parser": "^4.0.7",
         "hjson": "^3.2.2",
         "is-installed-globally": "0.4.0",
         "joi": "17.6.0",
@@ -41,5 +42,15 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "e00e8d06964b4a7fc5a0095ea510fc26a06520a8"
+    "keywords": [
+        "magento",
+        "docker",
+        "php",
+        "nginx",
+        "redis",
+        "elasticsearch",
+        "mysql",
+        "scandipwa"
+    ],
+    "gitHead": "cc46e60ca1d44d6e00b151e03af5cc7f56a5e54a"
 }

package/readme.md

@@ -1,150 +1,80 @@
 # magento-scripts
 
-This package contains scripts and configuration used by Create Magento App by [Create Magento App](https://github.com/scandipwa/create-magento-app).
+This package contains scripts and configuration used by [Create Magento App](https://github.com/scandipwa/create-magento-app).
 
 ## Overview
 
 What this package does:
-- Compiles correct php with all necessary extensions to run Magento on your system.
-- Organize services required to run Magento on your system, such as Nginx, Redis, MySQL and Elasticsearch, in docker containers with forwarded ports to host system.
+- Compiles correct PHP version with all necessary extensions to run Magento on your system.
+- Organize services required to run Magento on your system, such as Nginx, Redis, MySQL and Elasticsearch in Docker containers with forwarded ports to host system.
 - Allows you to run multiple M2 projects simultaneously on the same machine without ports/files/context overlapping.
 
+## Requirements
+
+### Linux Requirements
+
+Dependency list and installation guide is available in our [documentation for installation on Linux](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-linux)!
+
+### MacOS Requirements
+
+Dependency list and installation guide is available in our [documentation for installation on Mac](https://docs.create-magento-app.com/getting-started/prerequisites/installation-on-macos)!
+
+### Windows Requirements
+
+Dependency list and installation guide is available in our [documentation for installation on Windows](https://docs.create-magento-app.com/getting-started/prerequisites/windows-requirements)!
+
+> If you miss a requirement CMA will tell you and will give instructions or even provide a one click fix!
+
 ## Usage
 
-```bash
-> npx create-magento-app <folder name>
-> cd <folder name>
-> yarn/npm run start
-```
+### Start the App
 
-To use commands such as `composer`, `magento` and `php` with correct version run command:
 ```bash
-> yarn/npm cli
-```
-This will open bash with correct aliases to `php`, `magento` and `composer`.
+# Create an App
+npx create-magento-app <folder name>
 
-To open logs use command `logs` with one of the scopes: `redis`, `mysql`, `elasticsearch`, `nginx` or `magento`.
-```bash
-> yarn/npm run logs nginx
-> // nginx logs
+cd <folder name>
+
+# Run it with yarn
+yarn start
+
+# Or with npm
+npm run start
 ```
 
-> NOTE: you can use shortcuts for logs! Like `yarn logs m` will show `mysql` logs, `yarn logs ma` will show `magento` logs and e.t.c.
+> Documentation for `start` command is available [here](https://docs.create-magento-app.com/getting-started/available-commands/start).
 
-## Requirements
+### Access Application CLI
 
-- [Docker](https://docs.docker.com/get-docker/) ^19
-- [phpbrew](https://github.com/phpbrew/phpbrew) ^1.25
-
-For Mac
-- MacOS 10.5 and newer
-- Xcode 11 and newer You can find it.
-- [Homebrew](https://brew.sh/)
-
-## Dependencies
-
-### Ubuntu
-
-```sh
-apt-get install \
-    libcurl4-openssl-dev \
-    libonig-dev \
-    libjpeg-dev \
-    libjpeg8-dev \
-    libjpeg-turbo8-dev \
-    libpng-dev \
-    libicu-dev \
-    libfreetype6-dev \
-    libzip-dev \
-    libssl-dev \
-    build-essential \
-    libbz2-dev \
-    libreadline-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    libxml2-dev \
-    libxslt-dev \
-    libonig-dev \
-    php-cli \
-    php-bz2 \
-    pkg-config \
-    autoconf
+To access Magento CLI, Composer and PHP use `cli` command:
+```bash
+# With yarn
+yarn cli
+
+# Or npm
+npm run cli
 ```
 
-### Mint Linux
+This will a new instance of Bash with aliases for PHP, Composer and Magento used in Create Magento App project.
 
-```
-apt-get install \
-    libjpeg-dev \
-    libjpeg8-dev \
-    libjpeg-turbo8-dev \
-    libpng-dev \
-    libicu-dev \
-    libfreetype6-dev \
-    libzip-dev \
-    libssl-dev \
-    build-essential \
-    libbz2-dev \
-    libreadline-dev \
-    libsqlite3-dev \
-    libssl-dev \
-    libxml2-dev \
-    libxslt-dev \
-    libonig-dev \
-    php-cli \
-    php-bz2 \
-    pkg-config \
-    autoconf \
-    libcurl4-openssl-dev 
-```
+> Documentation for `cli` command is available [here](https://docs.create-magento-app.com/getting-started/available-commands/cli).
 
-### CentsOS / Fedora
-```sh
-yum install --enablerepo=PowerTools openssl-devel \
-    libjpeg-turbo-devel \
-    libpng-devel \
-    gd-devel \
-    libicu libicu-devel \
-    libzip-devel \
-    libtool-ltdl-devel \
-    oniguruma-devel
-```
+### Access Application Logs
 
-### Arch
-```sh
-pamac install freetype2 \
-    openssl \
-    oniguruma \
-    libxslt \
-    bzip2 \
-    libjpeg-turbo \
-    libpng \
-    icu \
-    libxml2 \
-    autoconf \
-    libzip \
-    sqlite \
-    readline \
-    perl
-```
+To open logs use command `logs` with one of the scopes: `redis`, `mysql`, `elasticsearch`, `nginx` or `magento`.
+```bash
+# With yarn
+yarn logs nginx
 
-### MacOS
+# Or npm
+npm run logs nginx
 
-```sh
-sudo xcode-select -switch /Applications/Xcode.app
-```
-```sh
-brew install zlib \
-    bzip2 \
-    libiconv \
-    curl \
-    libpng \
-    gd \
-    freetype \
-    oniguruma \
-    icu4c \
-    libzip
+> ... nginx logs
 ```
 
-Additional libraries:  
-- Installed PHP with json extension.  
+> NOTE: you can also use name matching for logs! Like `yarn logs m` will show `mysql` logs, `yarn logs ma` will show `magento` logs and e.t.c.  
+Read more about this [here](https://docs.create-magento-app.com/getting-started/available-commands/logs#usage-example).
+
+---
+
+CMA contains even more useful commands like [checking application status](https://docs.create-magento-app.com/getting-started/available-commands/status), [executing commands in Docker containers](https://docs.create-magento-app.com/getting-started/available-commands/exec), [linking a theme](https://docs.create-magento-app.com/getting-started/available-commands/link) and [importing database](https://docs.create-magento-app.com/getting-started/available-commands/import-db)!

package/typings/context.d.ts

@@ -1,6 +1,7 @@
 import mysql2 from 'mysql2';
 
 import { CMAConfiguration, PHPExtensions } from './index';
+import { PHPStormConfig } from './phpstorm';
 
 export interface ListrContext {
     magentoVersion: string
@@ -82,6 +83,7 @@ export interface ListrContext {
         overridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
         userConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
         nonOverridenConfiguration: Omit<CMAConfiguration, 'prefix' | 'useNonOverlappingPorts'>
+        phpStorm: PHPStormConfig
     }
     systemConfiguration: {
         analytics: boolean

package/typings/phpstorm.d.ts

@@ -0,0 +1,33 @@
+export interface PHPStormConfig {
+    xdebug: {
+        v2Port: string;
+        v3Port: string;
+        debugServerAddress: string;
+        serverName: string;
+        runManagerName: string;
+        sessionId: string;
+        path: string;
+        templatePath: string;
+    }
+    php: {
+        phpLanguageLevel: string;
+        path: string;
+        templatePath: string;
+    }
+    database: {
+        driver: string;
+        dataSourceManagerName: string;
+        dataSourcesLocal: {
+            path: string;
+            templatePath: string;
+        }
+        dataSources: {
+            path: string;
+            templatePath: string;
+        }
+    }
+    inspectionTools: {
+        path: string;
+        templatePath: string;
+    }
+}

package/lib/tasks/file-system/create-php-storm-config.js

@@ -1,82 +0,0 @@
-const setConfigFile = require('../../util/set-config');
-const pathExists = require('../../util/path-exists');
-const path = require('path');
-const fs = require('fs');
-
-const createPhpStormConfig = () => ({
-    title: 'Setting PHPStorm config',
-    task: async ({ config: { phpStorm }, ports }) => {
-        const { phpLanguageLevel } = phpStorm.php;
-        const jdbcUrl = `jdbc:mysql://localhost:${ports.mysql}/magento`;
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.xdebug.path,
-                template: phpStorm.xdebug.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during workspace.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.php.path,
-                template: phpStorm.php.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpLanguageLevel
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during php.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.database.dataSourcesLocal.path,
-                template: phpStorm.database.dataSourcesLocal.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.local.xml config creation\n\n${e}`);
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.database.dataSources.path,
-                template: phpStorm.database.dataSources.templatePath,
-                overwrite: true,
-                templateArgs: {
-                    phpStorm,
-                    jdbcUrl
-                }
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during dataSources.xml config creation\n\n${e}`);
-        }
-
-        if (!await pathExists(path.resolve('./.idea/dataSources'))) {
-            await fs.promises.mkdir(path.resolve('./.idea/dataSources'));
-        }
-
-        try {
-            await setConfigFile({
-                configPathname: phpStorm.inspectionTools.path,
-                template: phpStorm.inspectionTools.templatePath,
-                overwrite: true,
-                templateArgs: {}
-            });
-        } catch (e) {
-            throw new Error(`Unexpected error accrued during Project_Default.xml config creation\n\n${e}`);
-        }
-    }
-});
-
-module.exports = createPhpStormConfig;