@abcnews/aunty 13.0.3 → 13.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abcnews/aunty",
-  "version": "13.0.3",
+  "version": "13.1.0",
   "description": "A toolkit for working with ABC News projects",
   "repository": "abcnews/aunty",
   "license": "MIT",
@@ -38,11 +38,13 @@
     "@babel/preset-env": "^7.6.0",
     "@babel/preset-react": "^7.0.0",
     "@babel/preset-typescript": "^7.10.4",
+    "await-to-js": "^3.0.0",
     "babel-core": "^7.0.0-bridge.0",
     "babel-jest": "^26.1.0",
     "babel-loader": "^8.2.2",
+    "basic-ftp": "^5.0.2",
     "chalk": "^4.1.2",
-    "cli-select": "^1.1.0",
+    "cli-select": "^1.1.2",
     "copy-webpack-plugin": "^8.1.1",
     "css-loader": "^6.7.1",
     "csv-loader": "^3.0.3",
@@ -95,6 +97,7 @@
     "@abcaustralia/postcss-config": "^11.2.5"
   },
   "devDependencies": {
+    "babel-eslint": "^10.1.0",
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.2.0",
     "release-it": "^15.1.4"

package/src/cli/deploy/index.js

@@ -5,6 +5,9 @@ const { join } = require('path');
 // External
 const importLazy = require('import-lazy')(require);
 const loadJsonFile = importLazy('load-json-file');
+const { deploymentExists } = require('../../utils/ftp');
+const { to: wrap } = require('await-to-js');
+const cliSelect = importLazy('cli-select');
 
 // Ours
 const { command } = require('../');
@@ -12,10 +15,12 @@ const { addProfileProperties } = require('../../config/deploy');
 const { getProjectConfig } = require('../../config/project');
 const { DEPLOY_FILE_NAME, OUTPUT_DIRECTORY_NAME } = require('../../constants');
 const { packs, throws, unpack } = require('../../utils/async');
-const { dry, info, spin, warn } = require('../../utils/logging');
+const { dry, info, spin, warn, log, error } = require('../../utils/logging');
 const { ftp, rsync } = require('../../utils/remote');
 const { combine } = require('../../utils/structures');
 const { DEFAULTS, MESSAGES, VALID_TYPES } = require('./constants');
+const { dim, opt } = require('../../utils/color');
+const { check } = require('prettier');
 
 module.exports = command(
   {
@@ -83,24 +88,61 @@ module.exports = command(
     // 4b) Deploy
 
     for (let target of targets) {
-      const { publicPath, type } = target;
-      info(MESSAGES.deploy(target));
+      const { publicPath, type, to } = target;
+      let shouldOverwrite = false;
+
+      // If not ftp don't worry about checking external directory
+      if (type === 'ftp') {
+        const [checkErr] = await wrap(deploymentExists(to));
+
+        if (checkErr) {
+          if (checkErr.code === 550) {
+            // Directory doesn't exist. This is actually good though. OK to write.
+            shouldOverwrite = true;
+          } else {
+            error('An FTP error ocurred');
+          }
+        } else {
+          warn('Destination directory exists? OK to overwrite?');
+
+          const overwriteSelection = (
+            await cliSelect({
+              defaultValue: 1,
+              selected: opt('❯'),
+              unselected: ' ',
+              values: [
+                { label: 'Yes', choice: true },
+                { label: 'No', choice: false }
+              ],
+              valueRenderer: ({ label }, selected) => (selected ? opt(label) : label)
+            })
+          ).value;
+          shouldOverwrite = overwriteSelection.choice;
+          log(`${dim(`Destination overwrite: ${shouldOverwrite}`)}\n`);
+        }
+      }
+
+      if (shouldOverwrite || type === 'ssh') {
+        info(MESSAGES.deploy(target));
 
-      const spinner = spin('Deploying');
+        const spinner = spin('Deploying');
 
-      try {
-        if (type === 'ftp') {
-          throws(await ftp(target, spinner));
-        } else if (type === 'ssh') {
-          throws(await rsync(target));
+        try {
+          if (type === 'ftp') {
+            throws(await ftp(target, spinner));
+          } else if (type === 'ssh') {
+            throws(await rsync(target));
+          }
+        } catch (err) {
+          spinner.fail('Deployment failed');
+
+          throw err;
         }
-      } catch (err) {
-        spinner.fail('Deployment failed');
 
-        throw err;
+        spinner.succeed(MESSAGES.deployed(publicPath));
+      } else {
+        log('Exiting');
       }
-
-      spinner.succeed(MESSAGES.deployed(publicPath));
     }
   }
 );

package/src/cli/release/constants.js

@@ -2,7 +2,7 @@
 const { cmd, hvy, ok, opt, sec } = require('../../utils/color');
 
 const FORCE_REMINDER = `Use the ${opt('--force')} option to ignore warnings or release without tagging.`;
-const VALID_BUMPS = (module.exports.VALID_BUMPS = new Set(['major', 'minor', 'patch','prerelease']));
+const VALID_BUMPS = (module.exports.VALID_BUMPS = new Set(['major', 'minor', 'patch', 'prerelease']));
 
 const OPTIONS = (module.exports.OPTIONS = {
   string: ['bump', 'git-remote'],

package/src/config/deploy.js

@@ -139,3 +139,5 @@ module.exports.addProfileProperties = config => {
 
   return combine(config, profileProps);
 };
+
+module.exports.addKnownProfileProperties = addKnownProfileProperties;

package/src/generators/project/index.js

@@ -6,6 +6,8 @@ const getAllPaths = require('get-all-paths');
 const makeDir = require('make-dir');
 const requireg = require('requireg');
 const Generator = require('yeoman-generator');
+const { to: wrap } = require('await-to-js');
+const importLazy = require('import-lazy')(require);
 
 // Ours
 const { OUTPUT_DIRECTORY_NAME } = require('../../constants');
@@ -13,6 +15,9 @@ const { cmd, hvy, opt, sec } = require('../../utils/color');
 const { success } = require('../../utils/logging');
 const { installDependencies } = require('../../utils/npm');
 const { combine } = require('../../utils/structures');
+const { sluggify } = require('../../utils/text');
+const { projectExists } = require('../../utils/ftp');
+const { warn, info, error } = importLazy('../../utils/logging');
 
 module.exports = class extends Generator {
   constructor(args, opts) {
@@ -46,13 +51,51 @@ Shorthand examples (assuming xyz is your project name):
     let prompts = [];
 
     if (this.options.here) {
-      this.options.projectName = path.basename(process.cwd());
+      const currentDirectory = path.basename(process.cwd());
+
+      info(`Info: Using currect directory name as project name:`, currentDirectory, '\n');
+
+      const [err, exists] = await wrap(projectExists(sluggify(currentDirectory)));
+
+      if (exists)
+        warn(
+          'Warning: Project with the same name detected externally. ' +
+            'Danger of data loss if you continue. ' +
+            'Press ctrl+c to exit and rename project directory.'
+        );
+
+      if (err) {
+        warn(
+          'Warning: Unable to check if project name already exists, most likely ' +
+            'due to a connection or credentials error. Please check manually before deploying.\n'
+        );
+      }
+
+      this.options.projectName = currentDirectory;
     } else {
       prompts.push({
         type: 'input',
         name: 'projectName',
         message: 'What is your project called?',
-        default: this.options.projectName || 'New Project'
+        default: this.options.projectName || 'New Project',
+        validate: async input => {
+          const [err, exists] = await wrap(projectExists(sluggify(input)));
+
+          if (exists)
+            return (
+              'Error: Project seems to aleady exist on the FTP server and is in ' +
+              'danger of being overwritten. Please try a different name.'
+            );
+
+          if (err) {
+            warn(
+              'Warning: Unable to check if project name already exists, most likely ' +
+                'due to a connection or credentials error. Please check manually before deploying.\n'
+            );
+          }
+
+          return true;
+        }
       });
     }
 
@@ -90,10 +133,7 @@ Shorthand examples (assuming xyz is your project name):
 
     this.options.projectName = this.options.projectName.replace(/[^\w\-\_\s]/g, '');
 
-    this.options.projectNameSlug = this.options.projectName
-      .toLowerCase()
-      .replace(/\s/g, '-')
-      .replace(/[^0-9a-z\-\_]/g, '');
+    this.options.projectNameSlug = sluggify(this.options.projectName);
 
     this.options.projectNameFlat = this.options.projectNameSlug.replace(/-/g, '');
 

package/src/generators/project/templates/_common/README.md

@@ -1,7 +1,3 @@
 # <%= projectName %>
 
 A project generated from [aunty](https://github.com/abcnews/aunty)'s `<%= projectType %>` project template.
-
-## Authors
-
-- <%= authorName %> ([<%= authorEmail %>](mailto:<%= authorEmail %>))

package/src/generators/project/templates/_common/package.json

@@ -12,12 +12,13 @@
   },
   "scripts": {
     "start": "aunty serve",
+    "dev": "aunty serve",
     "test": "aunty test"
-  },
+  }<% if (projectType === "react") { %>,
   "abc": {
     "css": {
       "libraryDir": "./node_modules/@abcaustralia/nucleus/css",
       "logVariables": "false"
     }
-  }
+  }<% } %>
 }

package/src/utils/ftp.js

@@ -0,0 +1,75 @@
+// @ts-check
+
+const ftp = require('basic-ftp');
+const { to: wrap } = require('await-to-js');
+
+const { addProfileProperties, addKnownProfileProperties } = require('../config/deploy');
+
+/**
+ * Check if a project exists on FTP
+ * @param {string} projectNameSlug
+ * @returns {Promise<boolean>}
+ */
+const projectExists = async projectNameSlug => {
+  const config = addProfileProperties(addKnownProfileProperties({}));
+  const { host, username: user, password, to } = config;
+  const [baseDir] = to.split('<name>');
+
+  if (!host || !user || !password) throw new Error('Missing FTP credentials');
+
+  const client = new ftp.Client();
+
+  try {
+    await client.access({
+      host,
+      user,
+      password,
+      secure: false
+    });
+    await client.cd(baseDir);
+    const list = await client.list();
+
+    for (const item of list) {
+      if (projectNameSlug === item.name) return true;
+    }
+  } catch (err) {
+    throw err;
+  }
+
+  client.close();
+
+  return false;
+};
+
+/**
+ * Quick FTP check if deployment dir exists
+ * @param {string} deployToDir - Remote dir to check
+ * @returns {Promise<boolean>}
+ */
+const deploymentExists = async deployToDir => {
+  const config = addProfileProperties(addKnownProfileProperties({}));
+  const { host, username: user, password, to } = config;
+
+  const client = new ftp.Client();
+
+  const [accessErr] = await wrap(
+    client.access({
+      host,
+      user,
+      password,
+      secure: false
+    })
+  );
+  if (accessErr) throw accessErr;
+
+  const [cdError] = await wrap(client.cd(deployToDir));
+  if (cdError) {
+    throw cdError;
+  }
+
+  client.close();
+
+  return false;
+};
+
+module.exports = { projectExists, deploymentExists };

package/src/utils/text.js

@@ -50,3 +50,15 @@ module.exports.styleLastSegment = (str, style = identity, separator = SLASH) =>
     })
     .join(separator);
 };
+
+/**
+ * Return a sluggified version of the string
+ *
+ * @param {string} input - The string to convert
+ * @returns {string}
+ */
+module.exports.sluggify = input =>
+  input
+    .toLowerCase()
+    .replace(/\s/g, '-')
+    .replace(/[^0-9a-z\-\_]/g, '');