fix(new): improve experience of new command

This commit renames the "filename" argument to "namespace", creates the assets folder only when
assets exist and skips installing dependencies if unnecessary

re: #20

Author: dkundel

src/commands/new.ts

@@ -5,20 +5,20 @@ import prompts from 'prompts';
 import { Merge } from 'type-fest';
 import { Arguments, Argv } from 'yargs';
 import checkProjectStructure from '../checks/project-structure';
+import { downloadTemplate, fetchListOfTemplates } from '../templating/actions';
 import { CliInfo } from './types';
 import { getFullCommand } from './utils';
-import { downloadTemplate, fetchListOfTemplates } from '../templating/actions';
 
 export type NewCliFlags = Arguments<{
-  filename?: string;
+  namespace?: string;
   template?: string;
   list?: string;
 }>;
 
 export type NewConfig = Merge<
   NewCliFlags,
   {
-    filename?: string;
+    namespace?: string;
     template?: string;
   }
 >;
@@ -62,11 +62,12 @@ async function getMissingInfo(flags: NewCliFlags): Promise<NewConfig> {
     });
   }
 
-  if (!flags.filename) {
+  if (!flags.namespace) {
     questions.push({
       type: 'text',
-      name: 'filename',
-      message: 'What should be the name of your function?',
+      name: 'namespace',
+      message:
+        'What should be the namespace your function(s) are placed under?',
       validate: (input: string) => {
         if (input.length < 1 || input.includes(' ')) {
           return 'Your name cannot include whitespace';
@@ -79,7 +80,7 @@ async function getMissingInfo(flags: NewCliFlags): Promise<NewConfig> {
   if (questions.length === 0) {
     return {
       ...flags,
-      filename: flags.filename,
+      namespace: flags.namespace,
       template: flags.template,
     };
   }
@@ -88,7 +89,7 @@ async function getMissingInfo(flags: NewCliFlags): Promise<NewConfig> {
   return {
     ...flags,
     template: flags.template || answers.template,
-    filename: flags.filename || answers.filename,
+    namespace: flags.namespace || answers.namespace,
   };
 }
 
@@ -120,17 +121,17 @@ export async function handler(flagsInput: NewCliFlags): Promise<void> {
   const flags = await getMissingInfo(flagsInput);
 
   if (
-    typeof flags.filename === 'undefined' ||
-    flags.filename.length === 0 ||
+    typeof flags.namespace === 'undefined' ||
+    flags.namespace.length === 0 ||
     typeof flags.template === 'undefined' ||
-    flags.filename.length === 0
+    flags.namespace.length === 0
   ) {
     return;
   }
 
-  const bundleName = flags.filename.replace(/\.js$/, '');
+  const sanitizedNamespace = flags.namespace.replace(/\.js$/, '');
 
-  downloadTemplate(flags.template, bundleName, targetDirectory);
+  downloadTemplate(flags.template, sanitizedNamespace, targetDirectory);
 }
 
 export const cliInfo: CliInfo = {
@@ -162,7 +163,7 @@ function optionBuilder(yargs: Argv<any>): Argv<NewCliFlags> {
   return yargs;
 }
 
-export const command = ['new [filename]', 'template [filename]'];
+export const command = ['new [namespace]', 'template [namespace]'];
 export const describe =
   'Creates a new Twilio Function based on an existing template';
 export const builder = optionBuilder;

src/templating/filesystem.ts

@@ -1,16 +1,19 @@
 import { fsHelpers } from '@twilio-labs/serverless-api';
 import chalk from 'chalk';
+import debug from 'debug';
 import dotenv from 'dotenv';
+import { mkdir as oldMkdir } from 'fs';
 import got from 'got';
 import Listr, { ListrTask } from 'listr';
 import path from 'path';
 import { install, InstallResult } from 'pkg-install';
+import { promisify } from 'util';
 import { downloadFile, fileExists, readFile, writeFile } from '../utils/fs';
 import { TemplateFileInfo } from './data';
-import { mkdir as oldMkdir } from 'fs';
-import { promisify } from 'util';
 const mkdir = promisify(oldMkdir);
 
+const log = debug('twilio-run:templating:filesystem');
+
 async function writeEnvFile(
   contentUrl: string,
   targetDir: string,
@@ -59,12 +62,23 @@ async function writeEnvFile(
 async function installDependencies(
   contentUrl: string,
   targetDir: string
-): Promise<InstallResult> {
+): Promise<InstallResult | undefined> {
   const pkgContent = await got(contentUrl, { json: true });
   const dependencies = pkgContent.body.dependencies;
-  return install(dependencies, {
-    cwd: targetDir,
-  });
+  if (dependencies && Object.keys(dependencies).length > 0) {
+    return install(dependencies, {
+      cwd: targetDir,
+    });
+  }
+}
+
+function hasFilesOfType(files: TemplateFileInfo[], type: string) {
+  for (let file of files) {
+    if (file.type === type) {
+      return true;
+    }
+  }
+  return false;
 }
 
 export async function writeFiles(
@@ -82,22 +96,28 @@ export async function writeFiles(
   ]);
   const functionsTargetDir = path.join(functionsDir, bundleName);
   const assetsTargetDir = path.join(assetsDir, bundleName);
+
   if (functionsTargetDir !== functionsDir) {
-    try {
-      await mkdir(functionsTargetDir);
-    } catch (err) {
-      console.error(err);
-      throw new Error(
-        `Bundle with name "${bundleName}" already exists in "${functionsDir}"`
-      );
+    if (hasFilesOfType(files, 'functions')) {
+      try {
+        await mkdir(functionsTargetDir);
+      } catch (err) {
+        log(err);
+        throw new Error(
+          `Bundle with name "${bundleName}" already exists in "${functionsDir}"`
+        );
+      }
     }
-    try {
-      await mkdir(assetsTargetDir);
-    } catch (err) {
-      console.error(err);
-      throw new Error(
-        `Bundle with name "${bundleName}" already exists in "${assetsDir}"`
-      );
+
+    if (hasFilesOfType(files, 'assets')) {
+      try {
+        await mkdir(assetsTargetDir);
+      } catch (err) {
+        log(err);
+        throw new Error(
+          `Bundle with name "${bundleName}" already exists in "${assetsDir}"`
+        );
+      }
     }
   }