@commercetools-frontend/create-mc-app 21.8.1 → 21.11.0

package/src/{validations.js → validations.ts}

@@ -1,18 +1,30 @@
-const fs = require('fs');
-const path = require('path');
-const { isSemVer } = require('./utils');
+import fs from 'fs';
+import path from 'path';
+import semver from 'semver';
+import type { TCliCommandOptions } from './types';
+import { isSemVer } from './utils';
 
-const availableTemplates = ['starter', 'starter-typescript'];
+const availableTemplates = {
+  starter: 'starter',
+  'starter-typescript': 'starter-typescript',
+} as const;
 
-const throwIfTemplateIsNotSupported = (templateName) => {
-  if (!availableTemplates.includes(templateName)) {
-    throw new Error(
-      `The provided template name "${templateName}" does not exist. Available templates are "${availableTemplates.toString()}". Make sure you are also using the latest version of "@commercetools-frontend/create-mc-app".`
-    );
+const throwIfTemplateIsNotSupported = (
+  templateName: TCliCommandOptions['template']
+) => {
+  switch (templateName) {
+    case availableTemplates.starter:
+    case availableTemplates['starter-typescript']:
+      break;
+    default:
+      const templateNamesList = Object.keys(availableTemplates).toString();
+      throw new Error(
+        `The provided template name "${templateName}" does not exist. Available templates are "${templateNamesList}". Make sure you are also using the latest version of "@commercetools-frontend/create-mc-app".`
+      );
   }
 };
 
-const throwIfProjectDirectoryExists = (dirName, dirPath) => {
+const throwIfProjectDirectoryExists = (dirName: string, dirPath: string) => {
   if (fs.existsSync(dirPath)) {
     throw new Error(
       `A directory named "${dirName}" already exists at this location "${dirPath}". Please choose a different project name or remove the directory, then try running the command again.`
@@ -21,9 +33,9 @@ const throwIfProjectDirectoryExists = (dirName, dirPath) => {
 };
 
 const throwIfTemplateVersionDoesNotExist = (
-  templateName,
-  templateFolderPath,
-  versionToCheck
+  templateName: string,
+  templateFolderPath: string,
+  versionToCheck: string
 ) => {
   if (!fs.existsSync(templateFolderPath)) {
     throw new Error(
@@ -47,15 +59,32 @@ const throwIfTemplateVersionDoesNotExist = (
   }
 };
 
-const throwIfInitialProjectKeyIsMissing = (initialProjectKey) => {
+const throwIfInitialProjectKeyIsMissing = (initialProjectKey?: string) => {
   if (!initialProjectKey) {
     throw new Error(`Provide a valid project key that you have access to.`);
   }
 };
 
-module.exports = {
+const throwIfNodeVersionIsNotSupported = (
+  currentNodeVersion: string,
+  expectedVersionRange: string
+) => {
+  const hasValidNodeVersion = semver.satisfies(
+    currentNodeVersion,
+    expectedVersionRange
+  );
+
+  if (!hasValidNodeVersion) {
+    throw new Error(
+      `You are running Node ${currentNodeVersion} but create-mc-app requires Node ${expectedVersionRange}. Please update your version of Node.`
+    );
+  }
+};
+
+export {
   throwIfTemplateIsNotSupported,
   throwIfProjectDirectoryExists,
   throwIfTemplateVersionDoesNotExist,
   throwIfInitialProjectKeyIsMissing,
+  throwIfNodeVersionIsNotSupported,
 };

package/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "extends": "@tsconfig/node16/tsconfig.json",
+  "compilerOptions": {
+    "resolveJsonModule": true
+  }
+}

package/src/hint-outdated-version.js

@@ -1,34 +0,0 @@
-const semver = require('semver');
-const execa = require('execa');
-
-module.exports = function hintOutdatedVersion(currentVersion) {
-  try {
-    const packageInfoForTagLatest = JSON.parse(
-      execa.sync(
-        'npm',
-        ['view', '@commercetools-frontend/create-mc-app', '--json'],
-        {
-          encoding: 'utf-8',
-          stdio: 'ignore',
-        }
-      )
-    );
-
-    const hasBeenReleastedInLatestTag = semver.gt(
-      packageInfoForTagLatest.version,
-      currentVersion
-    );
-
-    const hintNewerVersions = [
-      hasBeenReleastedInLatestTag && `${packageInfoForTagLatest.version}`,
-    ]
-      .filter(Boolean)
-      .join(', ');
-
-    if (hintNewerVersions.length > 0) {
-      console.log(`New version available! ${hintNewerVersions}`);
-    }
-  } catch (error) {
-    // Ignore errors, as this function should not affect the exit code of the command
-  }
-};

package/src/index.js

@@ -1,12 +0,0 @@
-const { isValidNodeVersion, shouldUseYarn } = require('./utils');
-const tasks = require('./tasks');
-const hintOutdatedVersion = require('./hint-outdated-version');
-const parseArguments = require('./parse-arguments');
-
-module.exports = {
-  isValidNodeVersion,
-  shouldUseYarn,
-  tasks,
-  hintOutdatedVersion,
-  parseArguments,
-};

package/src/parse-arguments.js

@@ -1,87 +0,0 @@
-/* eslint-disable no-console */
-const path = require('path');
-const readline = require('readline');
-const crypto = require('crypto');
-const {
-  throwIfTemplateIsNotSupported,
-  throwIfProjectDirectoryExists,
-  throwIfInitialProjectKeyIsMissing,
-} = require('./validations');
-const { isSemVer } = require('./utils');
-
-const rl = readline.createInterface({
-  input: process.stdin,
-  output: process.stdout,
-});
-
-const question = (query) =>
-  new Promise((resolve) => rl.question(query, resolve));
-
-const getTemplateName = (flags) => flags.template || 'starter';
-const getEntryPointUriPath = async (flags) => {
-  if (flags['entry-point-uri-path']) {
-    return flags['entry-point-uri-path'];
-  }
-
-  const templateName = getTemplateName(flags);
-  const randomEntryPointUriPath = `${templateName}-${crypto
-    .randomBytes(3)
-    .toString('hex')}`;
-
-  if (flags.yes) {
-    return randomEntryPointUriPath;
-  }
-
-  const answerEntryPointUriPath = await question(
-    `Provide the Custom Application entryPointUriPath (default "${randomEntryPointUriPath}"): `
-  );
-  return answerEntryPointUriPath || randomEntryPointUriPath;
-};
-const getInitialProjectKey = async (flags) => {
-  if (flags['initial-project-key']) {
-    return flags['initial-project-key'];
-  }
-
-  const initialProjectKey = await question(
-    `Provide the initial project key for local development: `
-  );
-
-  throwIfInitialProjectKeyIsMissing(initialProjectKey);
-
-  return initialProjectKey;
-};
-
-module.exports = async function parseArguments(flags) {
-  const [projectDirectoryName] = flags._;
-  if (!projectDirectoryName) {
-    throw new Error('Missing required argument "<project-directory>"');
-  }
-  const projectDirectoryPath = path.resolve(projectDirectoryName);
-
-  // Parse options
-  const templateName = getTemplateName(flags);
-  let tagOrBranchVersion = flags['template-version'] || 'main';
-  tagOrBranchVersion =
-    isSemVer(tagOrBranchVersion) && !tagOrBranchVersion.startsWith('v')
-      ? `v${tagOrBranchVersion}`
-      : tagOrBranchVersion;
-
-  // Validate options
-  throwIfProjectDirectoryExists(projectDirectoryName, projectDirectoryPath);
-  throwIfTemplateIsNotSupported(templateName);
-
-  // Read prompts
-  const entryPointUriPath = await getEntryPointUriPath(flags);
-  const initialProjectKey = await getInitialProjectKey(flags);
-
-  rl.close();
-
-  return {
-    projectDirectoryName,
-    projectDirectoryPath,
-    templateName,
-    tagOrBranchVersion,
-    entryPointUriPath,
-    initialProjectKey,
-  };
-};

package/src/tasks/index.js

@@ -1,13 +0,0 @@
-const downloadTemplate = require('./download-template');
-const installDependencies = require('./install-dependencies');
-const updatePackageJson = require('./update-package-json');
-const updateCustomApplicationConfig = require('./update-custom-application-config');
-const updateApplicationConstants = require('./update-application-constants');
-
-module.exports = {
-  downloadTemplate,
-  installDependencies,
-  updatePackageJson,
-  updateCustomApplicationConfig,
-  updateApplicationConstants,
-};

package/src/tasks/update-application-constants.js

@@ -1,48 +0,0 @@
-const os = require('os');
-const fs = require('fs');
-const path = require('path');
-const rcfile = require('rcfile');
-const prettier = require('prettier');
-const babel = require('@babel/core');
-const { resolveFilePathByExtension } = require('../utils');
-
-function replaceEntryPointUriPathInConstants(filePath, options) {
-  const result = babel.transformFileSync(filePath, {
-    plugins: [
-      function replaceConstants() {
-        return {
-          visitor: {
-            VariableDeclarator(nodePath) {
-              if (nodePath.node.id.name === 'entryPointUriPath') {
-                nodePath.node.init = babel.types.stringLiteral(
-                  options.entryPointUriPath
-                );
-              }
-            },
-          },
-        };
-      },
-    ],
-    retainLines: true,
-  });
-
-  const prettierConfig = rcfile('prettier', {
-    cwd: options.projectDirectoryPath,
-  });
-  const formattedData = prettier.format(result.code + os.EOL, prettierConfig);
-  fs.writeFileSync(filePath, formattedData, {
-    encoding: 'utf8',
-  });
-}
-
-module.exports = function updateApplicationConstants(options) {
-  return {
-    title: 'Updating application constants',
-    task: () => {
-      const applicationConstantsPath = resolveFilePathByExtension(
-        path.join(options.projectDirectoryPath, 'src/constants')
-      );
-      replaceEntryPointUriPathInConstants(applicationConstantsPath, options);
-    },
-  };
-};

package/src/tasks/update-custom-application-config.js

@@ -1,64 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const rcfile = require('rcfile');
-const prettier = require('prettier');
-const babel = require('@babel/core');
-const { wordify, resolveFilePathByExtension } = require('../utils');
-
-function replaceApplicationInfoInCustomApplicationConfig(filePath, options) {
-  const appName = wordify(options.entryPointUriPath);
-
-  const result = babel.transformFileSync(filePath, {
-    plugins: [
-      function replaceCustomApplicationConfig() {
-        return {
-          visitor: {
-            Identifier(nodePath) {
-              if (nodePath.isIdentifier({ name: 'name' })) {
-                nodePath.parent.value = babel.types.stringLiteral(appName);
-              }
-              if (nodePath.isIdentifier({ name: 'initialProjectKey' })) {
-                nodePath.parent.value = babel.types.stringLiteral(
-                  options.initialProjectKey
-                );
-              }
-              if (nodePath.isIdentifier({ name: 'defaultLabel' })) {
-                if (
-                  nodePath.findParent((parentPath) =>
-                    parentPath.get('key').isIdentifier({ name: 'mainMenuLink' })
-                  )
-                ) {
-                  nodePath.parent.value = babel.types.stringLiteral(appName);
-                }
-              }
-            },
-          },
-        };
-      },
-    ],
-    retainLines: true,
-  });
-
-  const prettierConfig = rcfile('prettier', {
-    cwd: options.projectDirectoryPath,
-  });
-  const formattedData = prettier.format(result.code, prettierConfig);
-  fs.writeFileSync(filePath, formattedData, {
-    encoding: 'utf8',
-  });
-}
-
-module.exports = function updateCustomApplicationConfig(options) {
-  return {
-    title: 'Updating Custom Applications config',
-    task: () => {
-      const customApplicationConfigPath = resolveFilePathByExtension(
-        path.join(options.projectDirectoryPath, 'custom-application-config')
-      );
-      replaceApplicationInfoInCustomApplicationConfig(
-        customApplicationConfigPath,
-        options
-      );
-    },
-  };
-};

package/src/utils.js

@@ -1,56 +0,0 @@
-const fs = require('fs');
-const execa = require('execa');
-const semver = require('semver');
-
-const isValidNodeVersion = (currentNodeVersion, expectedVersionRange) => {
-  const hasValidNodeVersion = semver.satisfies(
-    currentNodeVersion,
-    expectedVersionRange
-  );
-
-  if (!hasValidNodeVersion) {
-    console.error(
-      `You are running Node ${currentNodeVersion} but create-mc-app requires Node ${expectedVersionRange}. Please update your version of Node.`
-    );
-    process.exit(1);
-  }
-};
-
-const isSemVer = (version) => /^(v?)([0-9].[0-9].[0-9])+/.test(version);
-
-const shouldUseYarn = () => {
-  try {
-    const result = execa.sync('yarn', ['--version'], { stdio: 'ignore' });
-    return !result.failed;
-  } catch (error) {
-    return false;
-  }
-};
-
-const slugify = (name) => name.toLowerCase().replace(/_/gi, '-');
-
-const upperFirst = (value) => value.charAt(0).toUpperCase() + value.slice(1);
-
-const wordify = (slug) =>
-  slug
-    .split('-')
-    .map((word) => upperFirst(word))
-    .join(' ');
-
-const resolveFilePathByExtension = (requestedModule) => {
-  const fileExtension = ['.js', '.ts', '.mjs', '.cjs'].find((ext) => {
-    const filePath = `${requestedModule}${ext}`;
-    return fs.existsSync(filePath);
-  });
-  return `${requestedModule}${fileExtension}`;
-};
-
-module.exports = {
-  isValidNodeVersion,
-  isSemVer,
-  shouldUseYarn,
-  slugify,
-  wordify,
-  upperFirst,
-  resolveFilePathByExtension,
-};