Merge pull request #1 from react-storefront-community/feature/xdn

Add option to deploy to the Moovweb XDN

Author: markbrocato

.prettierrc

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "es5",
+  "printWidth": 100
+}

README.md

@@ -1,2 +1,24 @@
 # create-react-storefront
+
 A CLI for creating new apps based on react-storefront
+
+## Usage
+
+```
+npm create react-storefront (app-name)
+```
+
+To accept all of the defaults, run:
+
+```
+npm create react-storefront (app-name) --yes
+```
+
+## Development
+
+To run this app in development:
+
+```
+npm i
+npm start
+```

index.js

@@ -53,21 +53,14 @@ const argv = require('yargs')
     const returnedYargs = yargs
       .positional('app-name', {
         describe: 'A name for the new app',
-        type: 'string'
+        type: 'string',
       })
       .option('yes', {
         describe: 'Run in non-interactive mode, accepting all defaults.',
         default: false,
-        type: 'boolean'
+        type: 'boolean',
       })
       .alias('yes', 'y')
-      .option('branch', {
-        describe:
-          'Use a specific branch from react-storefront-starter-app as the app template (defaults to master). Example: --branch=commercial',
-        default: 'master',
-        type: 'string'
-      })
-      .alias('branch', 'b')
       .help()
       .alias('help', 'h')
       .wrap(yargs.terminalWidth())

lib/check-node-version.js

@@ -5,7 +5,9 @@ module.exports = function checkNodeVersion() {
 
   if (parseInt(major) < 8) {
     console.log('')
-    console.log(`React Storefront requires node v8 or newer. You're running node ${process.version}.`)
+    console.log(
+      `React Storefront requires node v8 or newer. You're running node ${process.version}.`
+    )
     console.log('')
     process.exit(0)
   }

lib/config-defaults.js

@@ -3,5 +3,5 @@ module.exports = {
   version: '1.0.0',
   license: 'UNLICENSED',
   private: true,
-  createDirectory: true
+  createDirectory: true,
 }

lib/create-react-storefront-internal.js

@@ -29,14 +29,16 @@ const createReactStorefrontInternal = async (options, userConfig) => {
   let spinner
 
   try {
-    spinner = ora('Downloading React Storefront app template...').start()
+    const message = `Downloading React Storefront ${userConfig.xdn ? 'XDN ' : ''}template...`
+
+    spinner = ora(message).start()
 
     await retrieveTemplate({
-      branch: options.branch,
-      targetPath: targetPath
+      branch: userConfig.xdn ? 'commercial' : 'master',
+      targetPath: targetPath,
     })
 
-    spinner.succeed('Downloading React Storefront app template... done.')
+    spinner.succeed(`${message} done.`)
   } catch (e) {
     spinner.fail('Download failed')
     console.error(e)

lib/create-react-storefront.js

@@ -19,19 +19,12 @@ const createReactStorefront = async options => {
     author: '',
     license: configDefaults.license,
     private: configDefaults.private,
-    createDirectory: configDefaults.createDirectory
-  }
-
-  if (!(await checkTemplateExistence(options.branch))) {
-    console.log(
-      `The ${options.branch} branch of react-storefront-starter-app does not exist. Check your spelling or use the default.`
-    )
-    return
+    createDirectory: configDefaults.createDirectory,
   }
 
   if (!options.yes) {
     try {
-      userConfig = await promptForConfig({ configUpstream: false })
+      userConfig = await promptForConfig(options)
     } catch (err) {
       console.log(err.message)
       return
@@ -43,5 +36,5 @@ const createReactStorefront = async options => {
 
 module.exports = {
   _calculateStartCommand,
-  createReactStorefront
+  createReactStorefront,
 }

lib/input-validation.js

@@ -14,7 +14,8 @@ const isTargetPathValid = targetPath => {
     // not valid.
     if (
       fs.existsSync(targetPath) &&
-      (!fs.statSync(targetPath).isDirectory() || fs.readdirSync(targetPath).length !== 0)) {
+      (!fs.statSync(targetPath).isDirectory() || fs.readdirSync(targetPath).length !== 0)
+    ) {
       return false
     }
     return true
@@ -27,5 +28,5 @@ const isTargetPathValid = targetPath => {
 }
 
 module.exports = {
-  isTargetPathValid
+  isTargetPathValid,
 }

lib/prompt-for-config.js

@@ -24,124 +24,83 @@ const _requireInput = value => {
   }
 }
 
-const defaultQuestions = [
+const questions = [
   {
     name: 'version',
     type: 'text',
     message: 'version',
-    initial: configDefaults.version
+    initial: configDefaults.version,
   },
   {
     name: 'description',
     type: 'text',
-    message: 'description'
+    message: 'description',
   },
   {
     name: 'repoUrl',
     type: 'text',
-    message: 'repository url'
+    message: 'repository url',
   },
   {
     name: 'author',
     type: 'text',
-    message: 'author'
+    message: 'author',
   },
   {
     name: 'license',
     type: 'text',
     message: 'license',
-    initial: configDefaults.license
+    initial: configDefaults.license,
   },
   {
     name: 'private',
     type: 'toggle',
     message: 'private',
     initial: configDefaults.private,
     active: configDefaults.private.toString(),
-    inactive: 'false'
+    inactive: 'false',
+  },
+  {
+    name: 'xdn',
+    message: 'Will you be deploying your app on the Moovweb XDN?',
+    type: 'toggle',
+    initial: false,
+    active: 'yes',
+    inactive: 'no',
   },
   {
     name: 'createDirectory',
     type: 'toggle',
-    message: 'create a directory for this app?',
+    message: 'Create a directory for this app?',
     initial: true,
     active: configDefaults.createDirectory ? 'yes' : 'no',
-    inactive: 'no'
-  }
-]
-
-const upstreamQuestions = [
-  {
-    name: 'prodHostname',
-    type: 'text',
-    message: 'hostname for production site in moov cloud',
-    validate: _requireInput
-  },
-  {
-    name: 'prodUpstream',
-    type: 'text',
-    message: 'upstream hostname for production moov cloud',
-    validate: _requireInput,
-    initial: _initialProdUpstream
+    inactive: 'no',
   },
-  {
-    name: 'devHostname',
-    type: 'text',
-    message: 'hostname for development site in moov cloud',
-    validate: _requireInput,
-    initial: _initialDevHostname
-  },
-  {
-    name: 'devUpstream',
-    type: 'text',
-    message: 'upstream hostname for development moov cloud',
-    validate: _requireInput,
-    initial: _initialDevUpstream
-  }
 ]
 
 /**
  * Prompt user for React Storefront configuration options.
  */
-const promptForConfig = async ({ configUpstream }) => {
+const promptForConfig = async () => {
   console.log(
     `\nLet's create a new React Storefront app! First, I need you to provide some information for package.json...\n`
   )
 
-  const defaultQuestionResponses = await prompts(defaultQuestions)
+  const answers = await prompts(questions)
 
   // If the user has not provided all input, abort.
-  if (Object.keys(defaultQuestionResponses).length !== defaultQuestions.length) {
+  if (Object.keys(answers).length !== questions.length) {
     throw new Error('User configuration is incomplete. Aborting.')
   }
 
-  if (configUpstream) {
-    console.log(
-      "\nYou've indicated that you'd like to configure an upstream site. Let's do that now...\n"
-    )
-
-    const upstreamQuestionResponses = await prompts(upstreamQuestions)
-
-    // If the user has not provided all input, abort.
-    if (Object.keys(upstreamQuestionResponses).length !== upstreamQuestions.length) {
-      throw new Error('User configuration is incomplete. Aborting.')
-    }
-
-    // Merge the answers to the different sets of questions into one
-    // configuration object. Note that this is acceptable only because all
-    // questions have unique names. When adding questions, ensure that this
-    // remains the case.
-    _.merge(defaultQuestionResponses, upstreamQuestionResponses)
-  }
-
   // If upstream responses were given, they have been merged into this object.
-  return defaultQuestionResponses
+  return answers
 }
 
 module.exports = {
   _initialDevHostname,
   _initialDevUpstream,
   _initialProdUpstream,
   _requireInput,
-  promptForConfig
+  promptForConfig,
 }

lib/retrieve-template.js

@@ -26,7 +26,7 @@ const _calculateTemplateUrl = branch => {
 const _downloadTemplate = async ({ templateUrl } = {}) => {
   try {
     await download(templateUrl, process.cwd(), {
-      filename: downloadedTemplateName
+      filename: downloadedTemplateName,
     })
   } catch (err) {
     handleError(
@@ -43,7 +43,7 @@ const _getTemplatePath = () => {
 const _unzipTemplate = async targetPath => {
   try {
     await decompress(_getTemplatePath(), targetPath, {
-      strip: 1
+      strip: 1,
     })
   } catch (err) {
     handleError(err, 'Error decompressing the React Storefront template. See error stack above.')
@@ -75,7 +75,7 @@ const retrieveTemplate = async ({ branch, targetPath }) => {
   }
 
   await _downloadTemplate({
-    templateUrl: _calculateTemplateUrl(branch)
+    templateUrl: _calculateTemplateUrl(branch),
   })
 
   await _unzipTemplate(targetPath)
@@ -92,5 +92,5 @@ module.exports = {
   _getTemplatePath,
   _unzipTemplate,
   retrieveTemplate,
-  checkTemplateExistence
+  checkTemplateExistence,
 }