wp-blank-scripts 2.4.1 → 2.6.0

package/cli/deploy.js

@@ -63,24 +63,20 @@ async function selectOptions() {
       message: answers => {
         const user = settings.server[answers.environment].user;
         const host = settings.server[answers.environment].host;
-        return chalk.cyan(
-          `Enter the path to your private key for user ${user} on host ${host}`
-        );
+        return chalk.cyan(`Enter the path to your private key for user ${user} on host ${host}`);
       },
       default: '~/.ssh/id_rsa',
       type: 'input',
-      when: answers =>
-        (answers.sql || answers.mode === DEPLOY_MODES.SQL_ONLY) &&
-        !answers.serverPassword,
+      when: answers => !answers.serverPassword,
     },
   ]);
 
   // Update options
   options.environment = selectedOptions.environment;
   options.mode = selectedOptions.mode || DEPLOY_MODES.SITE;
-  options.sql =
-    selectedOptions.sql || selectedOptions.mode === DEPLOY_MODES.SQL_ONLY;
+  options.sql = selectedOptions.sql || selectedOptions.mode === DEPLOY_MODES.SQL_ONLY;
   options.serverPassword = selectedOptions.serverPassword;
+  options.serverPrivateKey = selectedOptions.serverPrivateKey;
 
   // Only confirm options if they were entered via inquirer
   if (options.didPrompt && !optionsConfirmed) {
@@ -92,10 +88,7 @@ async function confirmOptions(selectedOptions) {
   const deploymentOptinos = [
     ['Environment', selectedOptions.environment],
     ['Mode', selectedOptions.mode],
-    [
-      'SQL',
-      selectedOptions.sql || selectedOptions.mode === DEPLOY_MODES.SQL_ONLY,
-    ],
+    ['SQL', selectedOptions.sql || selectedOptions.mode === DEPLOY_MODES.SQL_ONLY],
   ];
 
   const { confirm } = await inquirer.prompt([
@@ -118,9 +111,9 @@ async function confirmOptions(selectedOptions) {
 }
 
 async function promptForCommit(options, unstagedFiles) {
-  let warningMessage = `You are deploying changes with ${
-    unstagedFiles.length
-  } uncommitted file${unstagedFiles.length > 1 ? 's' : ''}`;
+  let warningMessage = `You are deploying changes with ${unstagedFiles.length} uncommitted file${
+    unstagedFiles.length > 1 ? 's' : ''
+  }`;
 
   logger.warn(warningMessage);
 

package/cli/settings.js

@@ -0,0 +1,159 @@
+const chalk = require('chalk');
+const inquirer = require('inquirer');
+
+const addSettings = require('../lib/addSettings');
+
+const logger = require('../logger');
+const getCliOptions = require('../utils/getCliOptions');
+const exitWithError = require('../utils/exitWithError');
+
+// Constants
+const { DEPLOY_OPTIONS } = require('../constants');
+
+async function confirmOptions(options) {
+  const environment = options.environment;
+  let projectSettings;
+  if (environment === 'production') {
+    projectSettings = [
+      ['Environment', options.environment],
+      ['URL', options.urlProduction],
+      ['Host', options.hostProduction],
+      ['Host Username', options.userProduction],
+      ['Destination', options.destinationProduction],
+      ['DB Name', options.dbNameProduction],
+      ['DB Username', options.dbUserNameProduction],
+      ['DB Password', options.dbPasswordProduction],
+    ];
+  }
+  if (environment === 'staging') {
+    projectSettings = [
+      ['Environment', options.environment],
+      ['URL', options.urlStaging],
+      ['Host', options.hostStaging],
+      ['Host Username', options.userStaging],
+      ['Destination', options.destinationStaging],
+      ['DB Name', options.dbNameStaging],
+      ['DB Username', options.dbUserNameStaging],
+      ['DB Password', options.dbPasswordStaging],
+    ];
+  }
+
+  const res = await inquirer.prompt([
+    {
+      name: 'confirm',
+      message: `Please confirm your project settings:\n${projectSettings
+        .map(([title, value]) => `${chalk.yellow(title)}: ${value}`)
+        .join('\n')}`,
+      type: 'confirm',
+      default: false,
+    },
+  ]);
+
+  return res.confirm;
+}
+
+module.exports = async () => {
+  try {
+    const options = await getCliOptions([
+      {
+        name: 'environment',
+        message: 'What environment are you adding settings for?',
+        choices: DEPLOY_OPTIONS,
+        type: 'list',
+      },
+      {
+        name: 'urlProduction',
+        message: 'What is the production URL?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'hostProduction',
+        message: 'What is the production server host?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'userProduction',
+        message: 'What is the production server user?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'destinationProduction',
+        message: 'What is the production path?',
+        when: answers => answers.environment === 'production',
+        default: answers => {
+          const user = answers.userProduction;
+          return `/home/${user}/public_html`;
+        },
+      },
+      {
+        name: 'dbNameProduction',
+        message: 'Production database name?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'dbUserNameProduction',
+        message: 'Production database username?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'dbPasswordProduction',
+        message: 'Production database password?',
+        when: answers => answers.environment === 'production',
+      },
+      {
+        name: 'urlStaging',
+        message: 'What is the staging URL?',
+        when: answers => answers.environment === 'staging',
+      },
+      {
+        name: 'hostStaging',
+        message: 'What is the staging server host?',
+        when: answers => answers.environment === 'staging',
+        default: 'staging.vivo.digital',
+      },
+      {
+        name: 'userStaging',
+        message: 'What is the staging server user?',
+        when: answers => answers.environment === 'staging',
+        default: 'stagingvivo',
+      },
+      {
+        name: 'destinationStaging',
+        message: 'What is the staging path?',
+        when: answers => answers.environment === 'staging',
+        default: answers => {
+          const user = answers.userStaging;
+          let url = answers.urlStaging;
+          url = url && url.replace('https://', '');
+          url = url && url.replace('/', '');
+          return `/home/${user}/${url}`;
+        },
+      },
+      {
+        name: 'dbNameStaging',
+        message: 'Staging database name?',
+        when: answers => answers.environment === 'staging',
+      },
+      {
+        name: 'dbUserNameStaging',
+        message: 'Staging database username?',
+        when: answers => answers.environment === 'staging',
+      },
+      {
+        name: 'dbPasswordStaging',
+        message: 'Staging database password?',
+        when: answers => answers.environment === 'staging',
+      },
+    ]);
+
+    logger.log('Updating settings...');
+    const confirmed = options.didPrompt ? await confirmOptions(options) : true;
+
+    if (confirmed) {
+      await addSettings(options);
+      logger.success(`${options.environment} Settings updated!`);
+    }
+  } catch (err) {
+    exitWithError(err);
+  }
+};

package/cli/setup.js

@@ -20,6 +20,7 @@ async function confirmOptions(options) {
     database,
     project,
     projectLocation,
+    projectSlug,
     agency,
     agencySlug,
     agencyWebsite,
@@ -29,6 +30,7 @@ async function confirmOptions(options) {
 
   const projectSettings = [
     ['Project Location', projectLocation],
+    ['Project Slug', projectSlug],
     ['Project Name', project],
     ['Agency', agency],
     ['Agency Slug', agencySlug],
@@ -61,6 +63,14 @@ async function selectOptions() {
       message: 'Where is the project located?',
       default: path.relative(documentRoot, getProjectPath()),
     },
+    {
+      name: 'projectSlug',
+      message: 'What is the project slug (folder name)?',
+      default: path
+        .relative(documentRoot, getProjectPath())
+        .split('/')
+        .pop(),
+    },
     {
       name: 'project',
       message: 'What is the project name?',
@@ -73,12 +83,12 @@ async function selectOptions() {
     },
     {
       name: 'agency',
-      message: 'What\'s the name of the agency?',
+      message: "What's the name of the agency?",
       default: defaultAnswers.agency,
     },
     {
       name: 'agencySlug',
-      message: 'What\'s the agency slug?',
+      message: "What's the agency slug?",
       default: defaultAnswers.agencySlug,
     },
     {
@@ -102,14 +112,9 @@ async function selectOptions() {
     database: slugify(`${res.agencySlug} ${res.project}`),
     // Ensure table prefix ends with an underscore
     tablePrefix:
-      res.tablePrefix[res.tablePrefix.length - 1] === '_'
-        ? res.tablePrefix
-        : `${res.tablePrefix}_`,
+      res.tablePrefix[res.tablePrefix.length - 1] === '_' ? res.tablePrefix : `${res.tablePrefix}_`,
     // Make sure there is no protocol on the domain
-    productionDomain: (res.productionDomain || '').replace(
-      /^http(s?):\/\/(www.)?/,
-      ''
-    ),
+    productionDomain: (res.productionDomain || '').replace(/^http(s?):\/\/(www.)?/, ''),
   });
 
   // Only confirm options if they were entered via inquirer

package/index.js

@@ -11,8 +11,10 @@ const importSQL = require('./cli/import');
 const exportSQL = require('./cli/export');
 const pullSQL = require('./cli/pull');
 const upgrade = require('./cli/upgrade');
+const settings = require('./cli/settings'); //@TODO rename... addDeployConfig
 
 const exitWithError = require('./utils/exitWithError');
+const logger = require('./logger');
 
 const _ = () => {};
 
@@ -27,6 +29,7 @@ yargs
       }),
     build
   )
+
   .command('backup', 'Backup', backup) // sync
   .command(
     'setup',
@@ -122,6 +125,15 @@ yargs
     hooks
   )
   .command('upgrade', 'Upgrade to v0.4', _, upgrade)
+  .command(
+    'settings',
+    'Add Deployment Settings',
+    yargs =>
+      yargs.option('environment', {
+        describe: 'What environment are you adding settings for?',
+      }),
+    settings
+  )
   .help()
   .alias('h', 'help')
   .demandCommand()

package/lib/addSettings.js

@@ -0,0 +1,64 @@
+const fs = require('fs');
+const glob = require('glob');
+const slugify = require('slugify');
+const replace = require('replace-in-file');
+
+const logger = require('../logger');
+const getProjectPath = require('../utils/getProjectPath');
+
+const getReplacements = options => {
+  if (options.environment === 'production') {
+    return [
+      ['{{url_production}}', options.urlProduction],
+      ['{{server_url_production}}', options.hostProduction],
+      ['{{server_username_production}}', options.userProduction],
+      ['{{server_destination_production}}', options.destinationProduction],
+      ['{{db_name_production}}', options.dbNameProduction],
+      ['{{db_username_production}}', options.dbUserNameProduction],
+      ['{{db_password_production}}', options.dbPasswordProduction],
+    ];
+  }
+  if (options.environment === 'staging') {
+    return [
+      ['{{url_staging}}', options.urlStaging],
+      ['{{server_url_staging}}', options.hostStaging],
+      ['{{server_username_staging}}', options.userStaging],
+      ['{{server_destination_staging}}', options.destinationStaging],
+      ['{{db_name_staging}}', options.dbNameStaging],
+      ['{{db_username_staging}}', options.dbUserNameStaging],
+      ['{{db_password_staging}}', options.dbPasswordStaging],
+    ];
+  }
+  return;
+};
+
+module.exports = async options => {
+  const projectPath = getProjectPath();
+  const filesToReplace = [
+    ...glob.sync('config/*', { cwd: projectPath, dot: true }),
+    ...glob.sync('src/**/*.php', { cwd: projectPath }),
+  ];
+
+  const replacements = getReplacements(options);
+
+  let files = filesToReplace;
+  if (getProjectPath() !== process.cwd()) {
+    // Check if the script is being run from outside of the project and then fix the paths
+    files = files.map(file => getProjectPath(file));
+  }
+
+  // Remove any files that don't exist
+  files = files.filter(fs.existsSync);
+
+  // Run sequentially to ensure replace only operates on one file at a time
+  for (var i = 0; i < replacements.length; i++) {
+    const [from, to] = replacements[i];
+    await replace({
+      files,
+      from: new RegExp(from, 'g'),
+      to,
+    });
+  }
+
+  logger.log('Made replacements');
+};

package/lib/index.js

@@ -5,6 +5,7 @@ const devProject = require('./devProject');
 const exportSQL = require('./exportSQL');
 const importSQL = require('./importSQL');
 const setupProject = require('./setupProject');
+const addSettings = require('./addSettings');
 
 module.exports = {
   backupProject,
@@ -14,4 +15,5 @@ module.exports = {
   exportSQL,
   importSQL,
   setupProject,
+  addSettings,
 };

package/lib/setupProject.js

@@ -8,7 +8,7 @@ const getProjectPath = require('../utils/getProjectPath');
 
 const getReplacements = options => [
   ['{{projectLocation}}', options.projectLocation],
-  ['{{project}}', slugify(options.project)],
+  ['{{projectSlug}}', slugify(options.projectSlug).toLowerCase()],
   ['{{projectName}}', options.project],
   ['{{agency}}', options.agency],
   ['{{agencySlug}}', options.agencySlug],
@@ -16,9 +16,11 @@ const getReplacements = options => [
   ['{{tablePrefix}}', options.tablePrefix],
   ['{{database}}', options.database],
   ['{{productionDomain}}', options.productionDomain],
+  ['{{productionDomain}}', options.productionDomain],
+  ['project-slug-package-json', slugify(options.projectSlug).toLowerCase()],
 ];
 
-module.exports = async (options) => {
+module.exports = async options => {
   const projectPath = getProjectPath();
   const filesToReplace = [
     ...glob.sync('config/*', { cwd: projectPath, dot: true }),
@@ -28,6 +30,7 @@ module.exports = async (options) => {
     'README.md',
     'styleguide.html',
     'src/style.css',
+    'app/config/index.js',
   ];
 
   const replacements = getReplacements(options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wp-blank-scripts",
-  "version": "2.4.1",
+  "version": "2.6.0",
   "description": "Personal Wordpress Scripts",
   "main": "index.js",
   "bin": {

package/webpack.base.config.js

@@ -131,12 +131,6 @@ function makeBaseConfig(options) {
 
   if (fs.existsSync(mainStyleVariables)) {
     sassVariables = fs.readFileSync(mainStyleVariables, 'utf8');
-  } else {
-    logger.warn(
-      `Could not find your SASS variables file. Please make sure it exists at ${chalk.yellow(
-        'assets/css/utils/variables.scss'
-      )}`
-    );
   }
 
   let loaderOverrides = {};