@flutry/cli 1.1.0 → 1.1.2

package/dist/commands/new.d.ts

@@ -9,6 +9,7 @@ type Answers = {
     dbHost: string;
     dbPort: string;
     dbType: 'mysql' | 'mariadb';
+    socketio: boolean;
     packageManager: PackageManager;
     installNow: boolean;
 };

package/dist/commands/new.js

@@ -33,19 +33,44 @@ async function promptQuestions() {
         default: folderName.toLowerCase().replace(/\s+/g, '-'),
         validate: validatePackageName,
     });
-    const database = await (0, prompts_1.confirm)({ message: `${chalk_1.default.yellow('🗄️')} Enable database?`, default: false });
+    const database = await (0, prompts_1.confirm)({
+        message: `${chalk_1.default.yellow('🗄️')} Enable database?`,
+        default: true,
+    });
     const databaseAnswers = database
         ? {
-            dbName: await (0, prompts_1.input)({ message: `${chalk_1.default.yellow('◈')} Database name:`, default: 'flutrydb' }),
-            dbUser: await (0, prompts_1.input)({ message: `${chalk_1.default.yellow('◈')} Database user:`, default: 'root' }),
-            dbPass: await (0, prompts_1.password)({ message: `${chalk_1.default.yellow('◈')} Database password:`, mask: '*' }),
-            dbHost: await (0, prompts_1.input)({ message: `${chalk_1.default.yellow('◈')} Database host:`, default: 'localhost' }),
-            dbPort: await (0, prompts_1.input)({ message: `${chalk_1.default.yellow('◈')} Database port:`, default: DEFAULTS.dbPort, validate: validatePort }),
+            dbName: await (0, prompts_1.input)({
+                message: `${chalk_1.default.yellow('◈')} Database name:`,
+                default: 'flutrydb',
+            }),
+            dbUser: await (0, prompts_1.input)({
+                message: `${chalk_1.default.yellow('◈')} Database user:`,
+                default: 'root',
+            }),
+            dbPass: await (0, prompts_1.password)({
+                message: `${chalk_1.default.yellow('◈')} Database password:`,
+                mask: '*',
+            }),
+            dbHost: await (0, prompts_1.input)({
+                message: `${chalk_1.default.yellow('◈')} Database host:`,
+                default: 'localhost',
+            }),
+            dbPort: await (0, prompts_1.input)({
+                message: `${chalk_1.default.yellow('◈')} Database port:`,
+                default: DEFAULTS.dbPort,
+                validate: validatePort,
+            }),
             dbType: await (0, prompts_1.select)({
                 message: `${chalk_1.default.yellow('◈')} Database type:`,
                 choices: [
-                    { name: 'MariaDB', value: 'mariadb' },
-                    { name: 'MySQL', value: 'mysql' },
+                    {
+                        name: 'MariaDB',
+                        value: 'mariadb',
+                    },
+                    {
+                        name: 'MySQL',
+                        value: 'mysql',
+                    },
                 ],
                 default: DEFAULTS.dbType,
             }),
@@ -58,12 +83,25 @@ async function promptQuestions() {
             dbPort: '',
             dbType: DEFAULTS.dbType,
         };
+    const socketio = await (0, prompts_1.confirm)({
+        message: `${chalk_1.default.yellow('🔌')} Enable Socket.IO?`,
+        default: true,
+    });
     const packageManager = await (0, prompts_1.select)({
         message: `${chalk_1.default.magenta('⚙')} Package manager:`,
         choices: [
-            { name: 'npm', value: 'npm' },
-            { name: 'Yarn', value: 'yarn' },
-            { name: 'pnpm', value: 'pnpm' },
+            {
+                name: 'npm',
+                value: 'npm',
+            },
+            {
+                name: 'Yarn',
+                value: 'yarn',
+            },
+            {
+                name: 'pnpm',
+                value: 'pnpm',
+            },
         ],
         default: 'npm',
     });
@@ -72,8 +110,12 @@ async function promptQuestions() {
         projectName,
         database,
         ...databaseAnswers,
+        socketio,
         packageManager,
-        installNow: await (0, prompts_1.confirm)({ message: `${chalk_1.default.green('⚡')} Install dependencies now?`, default: true }),
+        installNow: await (0, prompts_1.confirm)({
+            message: `${chalk_1.default.green('⚡')} Install dependencies now?`,
+            default: true,
+        }),
     };
 }
 function buildEnv(answers, example) {
@@ -82,7 +124,7 @@ function buildEnv(answers, example) {
         '# Server',
         `PORT=${DEFAULTS.port}`,
         `HOST=${DEFAULTS.host}`,
-        'PREFIX_API=',
+        'PREFIX_API=/',
         '# Database',
         `DB=${answers.database ? 'true' : 'false'}`,
         `DB_HOST=${example ? '' : answers.dbHost}`,
@@ -91,29 +133,122 @@ function buildEnv(answers, example) {
         `DB_USER=${example ? '' : answers.dbUser}`,
         `DB_PASS=${example ? '' : answers.dbPass}`,
         `DB_DIALECT=${answers.dbType}`,
+        '# Socket.IO',
+        `SOCKETIO=${answers.socketio ? 'true' : 'false'}`,
         '# Secrets',
         `SECRET_KEY=${secret('SECRET_KEY')}`,
         `SECRET_SALT=${secret('SECRET_SALT')}`,
         `JWT_SECRET_KEY=${secret('JWT_SECRET_KEY')}`,
-        ,
     ].join('\n');
 }
 async function removeIfPresent(filePath) {
-    await fs_1.promises.rm(filePath, { recursive: true, force: true });
+    await fs_1.promises.rm(filePath, {
+        recursive: true,
+        force: true,
+    });
+}
+/**
+ * Configures the generated main.ts file based
+ * on the Socket.IO selection.
+ */
+async function configureMainFile(targetDir, socketio) {
+    const mainPath = path_1.default.join(targetDir, 'src', 'main.ts');
+    if (!(await exists(mainPath))) {
+        throw new Error('src/main.ts was not found in the downloaded template.');
+    }
+    let content = await fs_1.promises.readFile(mainPath, 'utf8');
+    const socketConfiguration = socketio
+        ? `socket: {
+      cors: {
+        origin: '*',
+      },
+    },`
+        : `socket: false,`;
+    content = content.replace(/socket:\s*(?:false|\{[\s\S]*?\n\s*\}),/, socketConfiguration);
+    await fs_1.promises.writeFile(mainPath, content, 'utf8');
+}
+/**
+ * Creates the Socket.IO utility used by the generated
+ * application.
+ *
+ * The utility is only generated when Socket.IO is enabled.
+ *
+ * Generated structure:
+ *
+ * src/
+ * └── utils/
+ *     └── socket/
+ *         └── index.ts
+ */
+async function configureSocketUtils(targetDir, socketio) {
+    /**
+     * Socket.IO was not enabled, therefore no utility
+     * files should be generated.
+     */
+    if (!socketio) {
+        return;
+    }
+    const socketDirectory = path_1.default.join(targetDir, 'src', 'utils', 'socket');
+    const socketFile = path_1.default.join(socketDirectory, 'index.ts');
+    /**
+     * Make sure the complete utils/socket directory
+     * structure exists.
+     */
+    await fs_1.promises.mkdir(socketDirectory, {
+        recursive: true,
+    });
+    /**
+     * Generate the Socket.IO connection handler.
+     *
+     * getSocket() returns the Socket.IO instance that was
+     * already initialized by HttpServer.
+     */
+    const socketContent = `import { logger } from '@flutry/common';
+
+import { getSocket } from '@flutry/server';
+
+const io = getSocket();
+
+io.on('connection', (socket: any) => {
+  logger.info('Connect ' + socket.id);
+
+  socket.on('disconnect', () => {
+    logger.info('Disconnect ' + socket.id);
+  });
+});
+`;
+    await fs_1.promises.writeFile(socketFile, socketContent, 'utf8');
 }
 async function createProject(answers) {
     const targetDir = path_1.default.resolve(process.cwd(), answers.folderName);
-    const spinner = (0, ora_1.default)({ text: chalk_1.default.cyan('Creating project'), spinner: 'dots12', color: 'cyan' }).start();
+    const spinner = (0, ora_1.default)({
+        text: chalk_1.default.cyan('Creating project'),
+        spinner: 'dots12',
+        color: 'cyan',
+    }).start();
     try {
-        if (await exists(targetDir))
+        if (await exists(targetDir)) {
             throw new Error(`Folder "${answers.folderName}" already exists.`);
+        }
         spinner.text = chalk_1.default.blue('Downloading project template');
-        await (0, degit_1.default)('https://github.com/Flutry-HQ/flutry.git', { cache: false, force: true }).clone(targetDir);
+        await (0, degit_1.default)('https://github.com/Flutry-HQ/flutry.git', {
+            cache: false,
+            force: true,
+        }).clone(targetDir);
         spinner.text = chalk_1.default.magenta('Applying project settings');
         const packageJsonPath = path_1.default.join(targetDir, 'package.json');
         const packageJson = JSON.parse(await fs_1.promises.readFile(packageJsonPath, 'utf8'));
         packageJson.name = answers.projectName;
         await fs_1.promises.writeFile(packageJsonPath, `${JSON.stringify(packageJson, null, 2)}\n`, 'utf8');
+        /**
+         * Configure the HttpServer Socket.IO option.
+         */
+        await configureMainFile(targetDir, answers.socketio);
+        /**
+         * Generate the Socket.IO utility only
+         * when Socket.IO is enabled.
+         */
+        await configureSocketUtils(targetDir, answers.socketio);
         await Promise.all([
             fs_1.promises.writeFile(path_1.default.join(targetDir, '.env'), buildEnv(answers, false), 'utf8'),
             fs_1.promises.writeFile(path_1.default.join(targetDir, '.env.example'), buildEnv(answers, true), 'utf8'),
@@ -131,22 +266,31 @@ async function createProject(answers) {
     }
 }
 async function installPackages(targetDir, packageManager) {
-    const spinner = (0, ora_1.default)({ text: chalk_1.default.yellow(`Installing dependencies with ${packageManager}`), spinner: 'arc', color: 'yellow' }).start();
+    const spinner = (0, ora_1.default)({
+        text: chalk_1.default.yellow(`Installing dependencies with ${packageManager}`),
+        spinner: 'arc',
+        color: 'yellow',
+    }).start();
     await new Promise((resolve, reject) => {
         const executable = process.platform === 'win32' ? `${packageManager}.cmd` : packageManager;
         const command = process.platform === 'win32' ? (process.env.ComSpec ?? 'cmd.exe') : executable;
         const commandArgs = process.platform === 'win32' ? ['/d', '/s', '/c', executable, 'install'] : ['install'];
-        const child = (0, child_process_1.spawn)(command, commandArgs, { cwd: targetDir, stdio: ['ignore', 'pipe', 'pipe'] });
+        const child = (0, child_process_1.spawn)(command, commandArgs, {
+            cwd: targetDir,
+            stdio: ['ignore', 'pipe', 'pipe'],
+        });
         let errorOutput = '';
         child.stderr.on('data', (data) => {
             errorOutput += data.toString();
         });
         child.on('error', reject);
         child.on('close', (code) => {
-            if (code === 0)
+            if (code === 0) {
                 resolve();
-            else
+            }
+            else {
                 reject(new Error(`${packageManager} install failed${errorOutput ? `: ${errorOutput.trim()}` : ''}`));
+            }
         });
     });
     spinner.succeed(chalk_1.default.greenBright('Dependencies installed'));
@@ -173,16 +317,18 @@ async function newCommand() {
     try {
         const answers = await promptQuestions();
         const targetDir = await createProject(answers);
-        if (answers.installNow)
+        if (answers.installNow) {
             await installPackages(targetDir, answers.packageManager);
+        }
         console.log(`\n${chalk_1.default.greenBright('╭─')} ${chalk_1.default.bold.green('✓ Project ready')} ${chalk_1.default.greenBright('─'.repeat(19))}`);
         console.log(`${chalk_1.default.greenBright('│')} ${chalk_1.default.gray('Location:')} ${chalk_1.default.cyan(`./${answers.folderName}`)}`);
         console.log(`${chalk_1.default.greenBright('│')} ${chalk_1.default.gray('Next:')}`);
         console.log(`${chalk_1.default.greenBright('│')}   ${chalk_1.default.cyan(`cd ${answers.folderName}`)}`);
-        if (!answers.installNow)
+        if (!answers.installNow) {
             console.log(`${chalk_1.default.greenBright('│')}   ${chalk_1.default.yellow(`${answers.packageManager} install`)}`);
+        }
         console.log(`${chalk_1.default.greenBright('│')}   ${chalk_1.default.green(`${answers.packageManager} dev`)}`);
-        console.log(`${chalk_1.default.greenBright('╰────────────────────────────────────╯')}\n`);
+        console.log(`${chalk_1.default.greenBright('╰────────────────────────────────────')}\n`);
     }
     catch (error) {
         console.error(`\n${chalk_1.default.redBright('✖')} ${error instanceof Error ? error.message : 'Command failed.'}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flutry/cli",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Flurty project scaffolding CLI",
   "bin": {
     "flutry": "dist/index.js"