Merge pull request #57 from emulsify-ds/develop

Deploy

src/handlers/init.ts

@@ -4,7 +4,10 @@ import { existsSync, promises as fs } from 'fs';
 import simpleGit from 'simple-git';
 import ProgressBar from 'progress';
 
-import type { EmulsifyProjectConfiguration } from '@emulsify-cli/config';
+import type {
+  EmulsifyProjectConfiguration,
+  Platform,
+} from '@emulsify-cli/config';
 import type { InitHandlerOptions } from '@emulsify-cli/handlers';
 import {
   EMULSIFY_PROJECT_CONFIG_FILE,
@@ -43,7 +46,9 @@ export default function init(progress: InstanceType<typeof ProgressBar>) {
       (await getPlatformInfo()) || {};
 
     // If no platform name is given, and none can be detected, exit and error.
-    const platformName = options?.platform || autoPlatformName;
+    const platformName = (options?.platform || autoPlatformName) as
+      | Platform
+      | undefined;
     if (!platformName) {
       return log(
         'error',
@@ -57,7 +62,8 @@ export default function init(progress: InstanceType<typeof ProgressBar>) {
     });
 
     // Choose a folder name. If no machineName is given, create one using the project name.
-    const machineName = options?.machineName || strToMachineName(name);
+    const machineName =
+      options?.machineName || strToMachineName(name, platformName);
 
     // Collection information about the starter kit, such as the target directory,
     // starter repository, and checkout version.

src/util/strToMachineName.test.ts

@@ -9,4 +9,14 @@ describe('strToMachineName', () => {
       )
     ).toBe('live-meaningfully-and-do-not-persue-expediency');
   });
+
+  it('uses underscores if the given platform is drupal', () => {
+    expect.assertions(1);
+    expect(
+      strToMachineName(
+        '^Live &meaningfully%%%%      and DO nOt!# persue $expediency**(#$',
+        'drupal'
+      )
+    ).toBe('live_meaningfully_and_do_not_persue_expediency');
+  });
 });

src/util/strToMachineName.ts

@@ -1,3 +1,9 @@
+import { Platform } from '@emulsify-cli/config';
+
+export const getMachineNameSpaceReplacement = (
+  platform?: Platform
+): '-' | '_' => (platform === 'drupal' ? '_' : '-');
+
 /**
  * Takes a string and converts it to a machine-friendly string by eliminating
  * non-alphanumeric characters, and replacing spaces with dashes.
@@ -6,15 +12,18 @@
  *
  * @returns machine-friendly version of the given string.
  */
-export default function strToMachineName(str: string): string {
+export default function strToMachineName(
+  str: string,
+  platform?: Platform
+): string {
   return (
     str
       // Filter out all non-alphanumeric/space characters.
       .replace(/[^A-Za-z0-9 ]/g, '')
       // Exclude double-spaces to prevent dual dashes.
       .replace(/\s{2,}/g, ' ')
       // Turn all spaces into dashes.
-      .replace(/\s/g, '-')
+      .replace(/\s/g, getMachineNameSpaceReplacement(platform))
       .toLowerCase()
   );
 }