@scandipwa/magento-scripts 2.0.3 → 2.0.4

package/lib/tasks/project-config/index.js

@@ -1,21 +1,25 @@
-const { setProjectConfig } = require('../../config/config');
-const { setPrefix: setPrefixUtil } = require('../../util/prefix');
+const { setProjectConfig } = require('../../config/config')
+const { setPrefix: setPrefixUtil } = require('../../util/prefix')
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const setProjectConfigTask = () => ({
     title: 'Settings project config',
     task: (ctx) => {
-        const { config: { overridenConfiguration: { prefix } } } = ctx;
+        const {
+            config: {
+                overridenConfiguration: { prefix }
+            }
+        } = ctx
 
-        setPrefixUtil(prefix);
+        setPrefixUtil(prefix)
 
-        setProjectConfig('debug', ctx.debug);
+        setProjectConfig('debug', ctx.debug)
     },
     options: {
         showTimer: false
     }
-});
+})
 
-module.exports = { setProjectConfigTask };
+module.exports = { setProjectConfigTask }

package/lib/tasks/requirements/composer-credentials.js

@@ -1,46 +1,58 @@
+/* eslint-disable @typescript-eslint/ban-ts-comment */
 /* eslint-disable no-nested-ternary */
-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 KnownError = require('../../errors/known-error');
-const UnknownError = require('../../errors/unknown-error');
+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 KnownError = require('../../errors/known-error')
+const UnknownError = require('../../errors/unknown-error')
 
-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 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 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';
+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>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 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.
+            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') }]`,
+                    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') }] `,
+                    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',
@@ -48,20 +60,26 @@ Where do you want to store them?`,
 
 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') }):`,
+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 'Username must not be empty'
                 }
 
-                return true;
+                return true
             }
-        });
+        })
 
         const passwordCredentials = await task.prompt({
             type: 'Input',
@@ -69,22 +87,30 @@ ${ logger.style.misc('Username') } (${ logger.style.misc('Public 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('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') }):`,
+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 'Password must not be empty'
                 }
 
-                return true;
+                return true
             }
-        });
+        })
 
         const authContent = {
             'http-basic': {
@@ -93,36 +119,46 @@ ${ logger.style.misc('Password') } (${ logger.style.misc('Private key') }):`,
                     password: passwordCredentials.trim()
                 }
             }
-        };
+        }
 
-        const authJsonContent = JSON.stringify(authContent, null, 4);
-        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(authContent, null, 0)}'`;
+        const authJsonContent = JSON.stringify(authContent, null, 4)
+        const authEnvContent = `export COMPOSER_AUTH='${JSON.stringify(
+            authContent,
+            null,
+            0
+        )}'`
 
-        process.env.COMPOSER_AUTH = JSON.stringify(JSON.parse(authJsonContent), null, 0);
+        process.env.COMPOSER_AUTH = JSON.stringify(
+            JSON.parse(authJsonContent),
+            null,
+            0
+        )
 
         if (configureLocation === 'auth.json') {
-            await fs.promises.writeFile(authJsonPath, authJsonContent, 'utf-8');
-            return;
+            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 KnownError(
-                `Unfortunately we cannot automatically add credentials for your shell ${process.env.SHELL}!
+            case 'bash':
+            case 'zsh': {
+                await fs.promises.appendFile(
+                    path.join(os.homedir(), shellConfigFileName),
+                    `\n${authEnvContent}\n`
+                )
+                break
+            }
+            default: {
+                throw new KnownError(
+                    `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()}`
-            );
-        }
+Add following string to your shell configuration file: ${logger.style.code()}`
+                )
+            }
         }
 
         await task.prompt({
@@ -131,92 +167,143 @@ Add following string to your shell configuration file: ${ logger.style.code()}`
 
 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>')}
+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`
-        });
+Press ${logger.style.misc('Y')} to continue`
+        })
     }
-});
+})
 
 /**
- * @type {() => import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
+ * @returns {import('listr2').ListrTask<import('../../../typings/context').ListrContext>}
  */
 const checkComposerCredentials = () => ({
     title: 'Checking Composer credentials',
     task: async (ctx, task) => {
-        const problems = new Map();
+        const problems = new Map()
         if (!process.env.COMPOSER_AUTH) {
-            problems.set(MISSING_COMPOSER_AUTH_ENV, true);
+            problems.set(MISSING_COMPOSER_AUTH_ENV, true)
         }
 
-        if (!await pathExists(authJsonPath)) {
-            problems.set(MISSING_AUTH_JSON, 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 (
+            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 rcFileContent = await fs.promises.readFile(
+                    shellConfigFilePath,
+                    'utf-8'
+                )
 
-                const lines = rcFileContent.split('\n');
-                const composerAuthInRcFile = lines.some((line) => line.startsWith('export COMPOSER_AUTH='));
+                const lines = rcFileContent.split('\n')
+                const composerAuthInRcFile = lines.some((line) =>
+                    line.startsWith('export COMPOSER_AUTH=')
+                )
 
                 if (composerAuthInRcFile) {
-                    doConfigure = false;
+                    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 !') }
+                        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='));
+                        const credentialsLine = lines.find((line) =>
+                            line.startsWith('export COMPOSER_AUTH=')
+                        )
                         process.env.COMPOSER_AUTH = JSON.stringify(
-                            JSON.parse(credentialsLine.replace('export COMPOSER_AUTH=', '').replace(/'/ig, '').trim()),
+                            JSON.parse(
+                                // credentialsLine does exists, we know it from check above
+                                // @ts-ignore
+                                credentialsLine
+                                    .replace('export COMPOSER_AUTH=', '')
+                                    .replace(/'/gi, '')
+                                    .trim()
+                            ),
                             null,
                             0
-                        );
-                        problems.delete(MISSING_COMPOSER_AUTH_ENV);
+                        )
+                        problems.delete(MISSING_COMPOSER_AUTH_ENV)
                     }
                 }
             }
 
             if (doConfigure) {
-                return task.newListr(
-                    configureComposerCredentials()
-                );
+                return task.newListr(configureComposerCredentials())
             }
         }
 
-        let composerAuthContent;
+        let composerAuthContent
 
         if (!problems.has(MISSING_AUTH_JSON)) {
             try {
-                const composerAuthFileContent = await fs.promises.readFile(authJsonPath, 'utf-8');
+                const composerAuthFileContent = await fs.promises.readFile(
+                    authJsonPath,
+                    'utf-8'
+                )
 
-                composerAuthContent = JSON.parse(composerAuthFileContent);
+                composerAuthContent = JSON.parse(composerAuthFileContent)
 
-                // eslint-disable-next-line max-len
-                const repoMagentoCredentials = composerAuthContent && composerAuthContent['http-basic'] && composerAuthContent['http-basic']['repo.magento.com'];
+                const repoMagentoCredentials =
+                    composerAuthContent &&
+                    composerAuthContent['http-basic'] &&
+                    composerAuthContent['http-basic']['repo.magento.com']
 
-                const hasEmptyCharacterInUsername = repoMagentoCredentials && /\s/i.test(repoMagentoCredentials.username);
-                const hasEmptyCharacterInPassword = repoMagentoCredentials && /\s/i.test(repoMagentoCredentials.password);
+                const hasEmptyCharacterInUsername =
+                    repoMagentoCredentials &&
+                    /\s/i.test(repoMagentoCredentials.username)
+                const hasEmptyCharacterInPassword =
+                    repoMagentoCredentials &&
+                    /\s/i.test(repoMagentoCredentials.password)
 
                 // TODO refactor to check all fields, not only for magento
-                const message = (hasEmptyCharacterInUsername && hasEmptyCharacterInPassword)
-                    ? `Both ${logger.style.misc('username')} and ${logger.style.misc('password')} fields in ${logger.style.misc('http-basic -> repo.magento.com')} in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+                const message =
+                    hasEmptyCharacterInUsername && hasEmptyCharacterInPassword
+                        ? `Both ${logger.style.misc(
+                              'username'
+                          )} and ${logger.style.misc(
+                              'password'
+                          )} fields in ${logger.style.misc(
+                              'http-basic -> repo.magento.com'
+                          )} in ${logger.style.file(
+                              './auth.json'
+                          )} contains empty characters (spaces).
 Do you want to remove them now? File will be overwritten.`
-                    : hasEmptyCharacterInUsername
-                        ? `Your ${logger.style.misc('http-basic -> repo.magento.com -> username')} field in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+                        : hasEmptyCharacterInUsername
+                        ? `Your ${logger.style.misc(
+                              'http-basic -> repo.magento.com -> username'
+                          )} field in ${logger.style.file(
+                              './auth.json'
+                          )} contains empty characters (spaces).
 Do you want to remove them now? File will be overwritten.`
                         : hasEmptyCharacterInPassword
-                            ? `Your ${logger.style.misc('http-basic -> repo.magento.com -> password')} field in ${logger.style.file('./auth.json')} contains empty characters (spaces).
+                        ? `Your ${logger.style.misc(
+                              'http-basic -> repo.magento.com -> password'
+                          )} field in ${logger.style.file(
+                              './auth.json'
+                          )} contains empty characters (spaces).
 Do you want to remove them now? File will be overwritten.`
-                            : null;
+                        : null
 
                 if (message) {
                     const response = await task.prompt({
@@ -229,60 +316,76 @@ Do you want to remove them now? File will be overwritten.`
                             },
                             {
                                 name: 'skip',
-                                message: 'No, I know what I\'m doing'
+                                message: "No, I know what I'm doing"
                             }
                         ]
-                    });
+                    })
 
                     if (response === 'overwrite') {
                         if (repoMagentoCredentials.username) {
-                            repoMagentoCredentials.username = repoMagentoCredentials.username.replace(/\s/i, '');
+                            repoMagentoCredentials.username =
+                                repoMagentoCredentials.username.replace(
+                                    /\s/i,
+                                    ''
+                                )
                         }
 
                         if (repoMagentoCredentials.password) {
-                            repoMagentoCredentials.password = repoMagentoCredentials.password.replace(/\s/i, '');
+                            repoMagentoCredentials.password =
+                                repoMagentoCredentials.password.replace(
+                                    /\s/i,
+                                    ''
+                                )
                         }
 
                         await fs.promises.writeFile(
                             authJsonPath,
                             JSON.stringify(composerAuthContent, null, 4),
                             'utf-8'
-                        );
+                        )
                     }
                 }
 
-                process.env.COMPOSER_AUTH = composerAuthFileContent;
+                process.env.COMPOSER_AUTH = composerAuthFileContent
             } catch (e) {
                 throw new UnknownError(
-                    `We found an error in your ${ logger.style.file('./auth.json') } file.
+                    `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/') }
+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);
+                composerAuthContent = JSON.parse(process.env.COMPOSER_AUTH)
             } catch (e) {
                 throw new UnknownError(
-                    `We found an error in your ${ logger.style.misc('$COMPOSER_AUTH') } environment variable.
+                    `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/') }
+You can try linting your variable here: ${logger.style.link(
+                        'https://jsonformatter.curiousconcept.com/'
+                    )}
 
 Error message that we got: ${e}`
-                );
+                )
             }
         }
     }
-});
+})
 
 module.exports = {
     checkComposerCredentials
-};
+}