feat: add support for the useGithub option in all the create-nx-* CLIs

tinesoft · tinesoft · commit a834492784c3 · 2025-01-30T21:51:30.000+01:00
diff --git a/e2e/nx-flutter-e2e/tests/create-nx-flutter.spec.ts b/e2e/nx-flutter-e2e/tests/create-nx-flutter.spec.ts
@@ -23,7 +23,7 @@ describe('create-nx-flutter', () => {
   `('should be installed with Nx Wrapper=$useNxWrapper', ({ useNxWrapper }) => {
     projectDirectory = createCLITestProject(
       'create-nx-flutter',
-      `--prjName=flutapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --no-interactive`
+      `--prjName=flutapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --useGitHub=false --no-interactive`
     );
 
     // npm ls will fail if the package is not installed properly
diff --git a/e2e/nx-micronaut-e2e/tests/create-nx-micronaut.spec.ts b/e2e/nx-micronaut-e2e/tests/create-nx-micronaut.spec.ts
@@ -23,7 +23,7 @@ describe('create-nx-micronaut', () => {
   `('should be installed with Nx Wrapper=$useNxWrapper', ({ useNxWrapper }) => {
     projectDirectory = createCLITestProject(
       'create-nx-micronaut',
-      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --no-interactive`
+      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --useGitHub=false --no-interactive`
     );
 
     // npm ls will fail if the package is not installed properly
diff --git a/e2e/nx-quarkus-e2e/tests/create-nx-quarkus.spec.ts b/e2e/nx-quarkus-e2e/tests/create-nx-quarkus.spec.ts
@@ -22,8 +22,8 @@ describe('create-nx-spring-boot', () => {
     ${false}
   `('should be installed with Nx Wrapper=$useNxWrapper', ({ useNxWrapper }) => {
     projectDirectory = createCLITestProject(
-      'create-nx-spring-boot',
-      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --no-interactive`
+      'create-nx-quarkus',
+      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --useGitHub=false --no-interactive`
     );
 
     // npm ls will fail if the package is not installed properly
diff --git a/e2e/nx-quarkus-e2e/tests/nx-quarkus.spec.ts b/e2e/nx-quarkus-e2e/tests/nx-quarkus.spec.ts
@@ -114,7 +114,7 @@ describe('nx-quarkus e2e', () => {
       expect(pomXml).toContain(`<artifactId>${artifactId}</artifactId>`);
       //expect(pomXml).toContain(`<version>${version}</version>`);
       expect(pomXml).toContain(
-        `<maven.compiler.releasez>21</maven.compiler.release>`
+        `<maven.compiler.release>21</maven.compiler.release>`
       );
 
       // make sure the build wrapper file is executable (*nix only)
diff --git a/e2e/nx-spring-boot-e2e/tests/create-nx-spring-boot.spec.ts b/e2e/nx-spring-boot-e2e/tests/create-nx-spring-boot.spec.ts
@@ -23,7 +23,7 @@ describe('create-nx-spring-boot', () => {
   `('should be installed with Nx Wrapper=$useNxWrapper', ({ useNxWrapper }) => {
     projectDirectory = createCLITestProject(
       'create-nx-spring-boot',
-      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --no-interactive`
+      `--prjName=bootapp --useNxWrapper=${useNxWrapper} --nxCloud=skip --useGitHub=false --no-interactive`
     );
 
     // npm ls will fail if the package is not installed properly
diff --git a/packages/common-cli/src/lib/main.ts b/packages/common-cli/src/lib/main.ts
@@ -1,114 +1,178 @@
-import { intro, text, confirm, spinner, note, outro, select } from '@clack/prompts';
+import {
+  intro,
+  text,
+  confirm,
+  spinner,
+  note,
+  outro,
+  select,
+} from '@clack/prompts';
 import { createWorkspace } from 'create-nx-workspace';
 import * as yargs from 'yargs';
 import * as terminalLink from 'terminal-link';
 
 import { CLIArguments } from './models';
-import { createNxWorkspaceVersion, createWorkspaceWithNxWrapper, getNxCommand } from './utils';
+import {
+  createNxWorkspaceVersion,
+  createWorkspaceWithNxWrapper,
+  getNxCommand,
+} from './utils';
 
-export async function mainCLI(pkgName: string, stackName: string) {
+// change type to ('yes' | 'github' | 'gitlab' | 'azure' | 'bitbucket-pipelines' | 'circleci' | 'skip');
+// and uncomment below prompt options, once https://github.com/nrwl/nx/pull/29008 is merged
+export type NxCloud = 'yes' | 'github' | 'circleci' | 'skip';
 
-  const pkgFolderName = pkgName.replace('@nxrocks/', '')
+export async function mainCLI(pkgName: string, stackName: string) {
+  const pkgFolderName = pkgName.replace('@nxrocks/', '');
   const createPkgName = `create-${pkgFolderName}`;
 
   intro(createPkgName);
 
-  const options = (yargs
-    .parserConfiguration({
-      'strip-dashed': true,
-    })
-    .command(
-      '$0 [name]',
-      `Create a new Nx workspace with ${stackName} support`,
-      (yargs) => yargs.option('name',
-        {
-          describe: 'Workspace name (e.g. org name)',
-          type: 'string',
-        }).
-        option('useNxWrapper',
-          {
-            describe: 'Let Nx manages its own installation and updates',
-            type: 'boolean',
-          }).
-          option('nxCloud',
-          {
-            describe: "Do you want Nx Cloud to make your CI fast?",
-            choices: ['yes', 'github', 'circleci', 'skip'] as const
-          }).
-        option('verbose',
-          {
-            describe: "Enable more logging information",
-            type: 'boolean',
-            default: process.env['NX_VERBOSE_LOGGING'] === 'true',
-          })
-    )
-    .help('help', 'Show help') as yargs.Argv<CLIArguments>).parseSync();
-
-  let { name, useNxWrapper, nxCloud } = options;
+  const options = (
+    yargs
+      .parserConfiguration({
+        'strip-dashed': true,
+      })
+      .command(
+        '$0 [name]',
+        `Create a new Nx workspace with ${stackName} support`,
+        (yargs) =>
+          yargs
+            .option('name', {
+              describe: 'Workspace Location (e.g. org name)',
+              type: 'string',
+            })
+            .option('useNxWrapper', {
+              describe: 'Let Nx manages its own installation and updates',
+              type: 'boolean',
+            })
+            .option('nxCloud', {
+              describe: 'Do you want Nx Cloud to make your CI fast?',
+              choices: ['yes', 'github', 'circleci', 'skip'] as const,
+            })
+            .option('useGitHub', {
+              describe:
+                'Will you be using GitHub as your git hosting provider?',
+              boolean: true,
+            })
+            .option('verbose', {
+              describe: 'Enable more logging information',
+              type: 'boolean',
+              default: process.env['NX_VERBOSE_LOGGING'] === 'true',
+            })
+      )
+      .help('help', 'Show help') as yargs.Argv<CLIArguments>
+  ).parseSync();
+
+  let { name, useNxWrapper, nxCloud, useGitHub } = options;
   const { _, $0, name: ignoredName, verbose, ...restArgs } = options;
 
-  name ||= await text({
-    message: 'What is the name of your workspace (e.g. org name)?',
+  name ||= (await text({
+    message: 'Where would you like to create your workspace?',
     initialValue: 'myorg',
-    validate: (value) => (value?.length === 0) ? 'You need to provide one' : void 0,
-  }) as string;
-
-  useNxWrapper ??= await confirm({
-    message: `Would you like to use Nx Wrapper? [ ${linkify('Nx Wrapper', 'https://nx.dev/concepts/more-concepts/nx-and-the-wrapper#and-the-nx-wrapper')} ]`,
-    initialValue: true
-  }) as boolean;
-
-  nxCloud ??= await select({
-    message: `Would you like Nx Cloud to make your CI faster? [ ${linkify('Nx Cloud', 'https://nx.app/?utm_source=' + createPkgName)} ]`,
+    validate: (value) =>
+      value?.length === 0 ? 'You need to provide one' : void 0,
+  })) as string;
+
+  useNxWrapper ??= (await confirm({
+    message: `Would you like to use Nx Wrapper? [ ${linkify(
+      'Nx Wrapper',
+      'https://nx.dev/concepts/more-concepts/nx-and-the-wrapper#and-the-nx-wrapper'
+    )} ]`,
+    initialValue: true,
+  })) as boolean;
+
+  nxCloud ??= (await select({
+    message: `Would you like Nx Cloud to make your CI faster? [ ${linkify(
+      'Nx Cloud',
+      'https://nx.app/?utm_source=' + createPkgName
+    )} ]`,
     options: [
-      { value: 'yes', label: 'Yes' },
-      { value: 'github', label: 'Github' },
+      { value: 'github', label: 'GitHub Actions' },
+      //{ value: 'gitlab', label: 'Gitlab' },
+      //{ value: 'azure', label: 'Azure DevOps' },
+      //{ value: 'bitbucket-pipelines', label: 'BitBucket Pipelines' },
       { value: 'circleci', label: 'Circle CI' },
-      { value: 'skip', label: 'Skip for now' },
+      { value: 'skip', label: '\nDo it later' },
     ],
-    initialValue: 'skip' as 'yes' | 'github' | 'circleci' | 'skip'
-  }) as 'yes' | 'github' | 'circleci' | 'skip';
+    initialValue: 'skip' as NxCloud,
+  })) as NxCloud;
+
+  useGitHub ??=
+    nxCloud === 'yes' ||
+    nxCloud === 'github' ||
+    ((await confirm({
+      message: `Will you be using GitHub as your git hosting provider?`,
+      initialValue: false,
+    })) as boolean);
 
   const presetVersion = 'latest';
-  
+
   let directory: string;
 
   const notes = [
-    `- Go to [ ${linkify(pkgName, 'https://github.com/tinesoft/nxrocks/tree/develop/packages/' + pkgFolderName)} ] to get started with Nx and ${stackName} plugin.`,
-    `- Run   [ ${getNxCommand(useNxWrapper)} g ${pkgName}:project ] to add more projects.`
+    `- Go to [ ${linkify(
+      pkgName,
+      'https://github.com/tinesoft/nxrocks/tree/develop/packages/' +
+        pkgFolderName
+    )} ] to get started with Nx and ${stackName} plugin.`,
+    `- Run   [ ${getNxCommand(
+      useNxWrapper
+    )} g ${pkgName}:project ] to add more projects.`,
   ];
 
   if (useNxWrapper) {
-    notes.push(`- Go to [ ${linkify('Nx Wrapper', 'https://nx.dev/concepts/more-concepts/nx-and-the-wrapper#and-the-nx-wrapper')} ] to get started with Nx Wrapper.`);
+    notes.push(
+      `- Go to [ ${linkify(
+        'Nx Wrapper',
+        'https://nx.dev/concepts/more-concepts/nx-and-the-wrapper#and-the-nx-wrapper'
+      )} ] to get started with Nx Wrapper.`
+    );
 
-    const allArgs = Object.entries(restArgs).map(([key, value]) => `--${key}=${value}`).join(' ');
+    const allArgs = Object.entries(restArgs)
+      .map(([key, value]) => `--${key}=${value}`)
+      .join(' ');
 
     const s = spinner();
     s.start('Initializing your workspace');
 
-    directory = createWorkspaceWithNxWrapper(name, pkgName, allArgs, nxCloud, presetVersion, createNxWorkspaceVersion, !verbose);
+    directory = createWorkspaceWithNxWrapper(
+      name,
+      pkgName,
+      allArgs,
+      nxCloud,
+      useGitHub,
+      presetVersion,
+      createNxWorkspaceVersion,
+      !verbose
+    );
 
     s.stop(`Successfully created the workspace: ${name}`);
-  }
-  else {
-    directory = (await createWorkspace(
-      `${pkgName}@${presetVersion}`,
-      {
+  } else {
+    directory = (
+      await createWorkspace(`${pkgName}@${presetVersion}`, {
         ...restArgs,
         name,
         nxCloud,
-        packageManager: 'npm'
-      }
-    ))?.directory;
+        useGitHub,
+        packageManager: 'npm',
+      })
+    )?.directory;
   }
 
-  notes.push(`- Go to [ ${linkify('Nx.dev', 'https://nx.dev')} ] to get started with Nx.`);
+  notes.push(
+    `- Go to [ ${linkify('Nx.dev', 'https://nx.dev')} ] to get started with Nx.`
+  );
 
-  note(notes.join('\n'), "Next steps");
+  note(notes.join('\n'), 'Next steps');
 
   outro(`Your workspace in ${directory} is all set 🎉. Let's goooooo! 🚀`);
 }
 
-function linkify(text: string, url: string, fallback = (text: string, url: string) => url) {
+function linkify(
+  text: string,
+  url: string,
+  fallback = (text: string, url: string) => url
+) {
   return terminalLink(text, url, { fallback });
-}
+}
diff --git a/packages/common-cli/src/lib/utils.ts b/packages/common-cli/src/lib/utils.ts
