Refactor/various cleanup

bin/cli.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { startAppGenerator } from "../src/code-generator";
+import { startAppGenerator } from "../src/code-generator/entry-points/cli-entry-point";
 import packageJSON from "../package.json";
 
 startAppGenerator();

src/code-generator/entry-points/cli-entry-point.ts

@@ -0,0 +1,33 @@
+const { program } = require("commander");
+import { renderWizard } from "./interactive-cli";
+const { handleNonInteractiveCommand } = require("./non-interactive-cli");
+
+export function startAppGenerator() {
+  console.log("Starting app generator");
+  program
+    .name("Practice - Best Practices Generator")
+    .description("Generate best practices for your project")
+    .version("0.0.1");
+
+  program
+    .command("interactive")
+    .description("Open an interactive UI for customization")
+    .action((str, options) => {
+      renderWizard();
+    });
+
+  program
+    .command("generate")
+    .description("Generates code using flags (a non-interactive CLI)")
+    .option("-f, --framework <string>", "Framework to use")
+    .option("-d, --db <string>", "DB to use")
+    .option("-id, --install-dependencies", "Whether to install dependencies")
+    .action((options) => {
+      handleNonInteractiveCommand(options);
+    });
+
+  program.option("--framework", "Use framework");
+  program.option("--db", "Use DB");
+
+  program.parse();
+}

src/code-generator/app-generation-wizard.tsx → src/code-generator/entry-points/interactive-cli.tsx

@@ -2,18 +2,10 @@
 const React = require("react");
 const { render, Text, Box, useStdout, Newline, Spacer, Transform } = require("ink");
 const MultiSelect = require("ink-multi-select").default;
-const Image = require("ink-image");
-const path = require("path");
 const SelectInput = require("ink-select-input").default;
 const TextInput = require("ink-text-input").UncontrolledTextInput;
-const BigText = require("ink-big-text");
 var figlet = require("figlet");
-const util = require("util");
-const { generateApp } = require("./generation-logic/generate-service");
-const { createAsExpression, readBuilderProgram } = require("typescript");
-const terminalImage = require("terminal-image");
-
-const promisifiedFiglet = util.promisify(figlet);
+const { generateApp } = require("../generation-logic/generate-service");
 
 const QuestionsWizard = () => {
   const initialQuestionsWizard = {

src/code-generator/entry-points/non-interactive-cli.tsx

@@ -0,0 +1,10 @@
+const { factorDefaultOptions } = require("../generation-logic/generation-options");
+const generateService = require("../generation-logic/generate-service");
+
+export function handleNonInteractiveCommand(options: any) {
+  const generationOptions = factorDefaultOptions({
+    installDependencies: options.installDependencies,
+    targetDirectory: process.cwd(),
+  });
+  generateService.generateApp(generationOptions);
+}

src/code-generator/generation-logic/generate-service.ts

@@ -3,11 +3,12 @@ import path from "path";
 import execa from "execa";
 import { generationOptions } from "./generation-options";
 
+// This is where the code generation logic lives. In high-level, based on the provided option, it creates
+// a folder, decides which code to generate, run the code through a templating engine and emit it to the target folder
 export const generateApp = async (options: generationOptions) => {
   const targetDirectory = path.join(options.targetDirectory, options.appName);
   const sourceDirectory = path.join(__dirname, "../../code-templates");
   console.log(`About to generate app`, options, targetDirectory);
-  console.time("copy");
   await fsExtra.mkdir(targetDirectory);
   await fsExtra.copy(sourceDirectory, targetDirectory, {
     // We don't want to copy the node_modules folder since it's slow and error-prone
@@ -19,16 +20,14 @@ export const generateApp = async (options: generationOptions) => {
       }
     },
   });
-  console.timeEnd("copy");
 
   if (options.installDependencies) {
-    console.time("install-dependencies");
+    // Dependencies should be installed from the app/microservice directory. All the rest is dependency of the app
     const microserviceDirectory = path.join(targetDirectory, "services", "order-service");
     await execa("npm", ["install"], { cwd: microserviceDirectory });
     // Temporarily install libraries modules, in the near future we will use a monorepo framework
     const MQLibraryDirectory = path.join(targetDirectory, "libraries", "message-queue-client");
     await execa("npm", ["install"], { cwd: MQLibraryDirectory });
-    console.timeEnd("install-dependencies");
   }
 
   console.log(`App was generated successfully`);

src/code-generator/index.ts

@@ -1,43 +1,2 @@
-#!/usr/bin/env node
-const { program } = require("commander");
-const util = require("util");
-
-import { renderWizard } from "./app-generation-wizard";
-const generateService = require("./generation-logic/generate-service");
-const { factorDefaultOptions } = require("./generation-logic/generation-options");
-
-export function startAppGenerator() {
-  program
-    .name("Practice - Best Practices Generator")
-    .description("Generate best practices for your project")
-    .version("0.0.1");
-
-  program
-    .command("wizard")
-    .description("Open an interactive UI for customization")
-    .action((str, options) => {
-      renderWizard();
-    });
-
-  program
-    .command("generate")
-    .description("Generates code using flags")
-    .option("-f, --framework <string>", "Framework to use")
-    .option("-d, --db <string>", "DB to use")
-    .option("-id, --install-dependencies", "Whether to install dependencies")
-    .action((options) => {
-      console.log(options.framework, options.db, options.installDependencies);
-      console.log(program.args, program.opts());
-      console.log(process.cwd());
-      const generationOptions = factorDefaultOptions({
-        installDependencies: options.installDependencies,
-        targetDirectory: process.cwd(),
-      });
-      generateService.generateApp(generationOptions);
-    });
-
-  program.option("--framework", "Use framework");
-  program.option("--db", "Use DB");
-
-  program.parse();
-}
+// The non-interactive CLI is the
+export * from "./entry-points/non-interactive-cli";

src/code-templates/services/order-service/start.js

@@ -1,5 +1,5 @@
-const { initializeWebServer } = require('./entry-points/api');
-const { MessageQueueStarter } = require('./entry-points/message-queue-starter');
+const { initializeWebServer } = require("./entry-points/api");
+const { MessageQueueStarter } = require("./entry-points/message-queue-starter");
 
 async function start() {
   await initializeWebServer();
@@ -8,8 +8,8 @@ async function start() {
 
 start()
   .then(() => {
-    console.log('The app has started successfully');
+    console.log("The app has started successfully");
   })
   .catch((error) => {
-    console.log('App occured during startup', error);
+    console.log("App occured during startup", error);
   });

test/e2e-flow.slow.test.ts

@@ -10,7 +10,7 @@ beforeEach(async () => {
 });
 
 afterEach(async () => {
-  //await fsExtra.remove(emptyFolderForATest);
+  await fsExtra.remove(emptyFolderForATest);
 });
 
 describe("Non-interactive", () => {