@flutry/cli 1.0.0

package/README.md

@@ -0,0 +1,157 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/Flutry-HQ/cli/main/assets/logo.png" alt="Flurty CLI logo" width="180">
+</p>
+
+# Flurty CLI
+
+A small, reliable command-line tool for creating and extending Flutry projects.
+
+## Features
+
+- Interactive Flutry project creation
+- Secure `.env` secret generation
+- Optional database configuration with MySQL or MariaDB
+- Route and service generation
+- Sequelize model generation
+- npm, Yarn, and pnpm support
+- Animated and colored terminal feedback
+- Safe protection against overwriting existing files
+
+## Installation
+
+Install the package globally:
+
+```bash
+npm install -g @flutry/cli
+```
+
+Or run it directly with `npx`:
+
+```bash
+npx @flutry/cli new
+```
+
+## Create A Project
+
+Start the interactive project generator:
+
+```bash
+flurty new
+```
+
+The generator asks for:
+
+- Project folder and package name
+- Database activation and connection settings
+- Package manager
+- Dependency installation
+
+After creation, the project includes `.env` and `.env.example` files.
+
+## Generate A Route
+
+Run this command from the root of an existing Flutry project:
+
+```bash
+flurty generate route user
+```
+
+This creates:
+
+```text
+src/routes/user/user.route.ts
+src/routes/user/user.service.ts
+```
+
+The generated route includes a basic `GET /user` endpoint that returns an `Ok` response.
+
+## Generate A Model
+
+Create a Sequelize model with:
+
+```bash
+flurty generate model user
+```
+
+This creates:
+
+```text
+src/models/user.model.ts
+```
+
+The generated model contains an `id` field, a required unique `message` field, and a Sequelize initializer.
+
+## Short Alias
+
+The `generate` command also has a short `g` alias:
+
+```bash
+flurty g route user
+flurty g model user
+```
+
+Generators only run inside a Flutry project. They check for `package.json` and the Flutry router before creating files.
+
+## Environment Configuration
+
+The generator creates a complete environment template, including database values even when the database is initially disabled:
+
+```env
+PORT=1337
+HOST=0.0.0.0
+PREFIX_API=
+DB=false
+DB_NAME=
+DB_USER=
+DB_PASS=
+DB_HOST=
+DB_PORT=3306
+DB_TYPE=mariadb
+SECRET_KEY=
+SECRET_SALT=
+JWT_SECRET_KEY=
+```
+
+The real `.env` file receives generated secrets. The `.env.example` file never receives database credentials or generated secrets.
+
+## Development
+
+Install dependencies:
+
+```bash
+yarn install
+```
+
+Build the CLI:
+
+```bash
+yarn build
+```
+
+Run the compiled CLI:
+
+```bash
+yarn start
+```
+
+Watch TypeScript files during development:
+
+```bash
+yarn dev
+```
+
+## Project Structure
+
+```text
+src/
+  commands/
+    generate.ts
+    new.ts
+  types/
+    degit.d.ts
+  index.ts
+```
+
+## License
+
+MIT

package/dist/commands/generate.d.ts

@@ -0,0 +1,2 @@
+export declare function generateRoute(name: string): Promise<void>;
+export declare function generateModel(name: string): Promise<void>;

package/dist/commands/generate.js

@@ -0,0 +1,154 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateRoute = generateRoute;
+exports.generateModel = generateModel;
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const chalk_1 = __importDefault(require("chalk"));
+const ora_1 = __importDefault(require("ora"));
+function normalizeName(name) {
+    const fileName = name.trim().toLowerCase();
+    if (!/^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/.test(fileName)) {
+        throw new Error('Name must contain lowercase letters, numbers, or hyphens and start with a letter.');
+    }
+    const className = fileName
+        .split('-')
+        .map((part) => part.charAt(0).toUpperCase() + part.slice(1))
+        .join('');
+    return { fileName, className };
+}
+function routeTemplate(className, fileName) {
+    return [
+        "import Router from '../../package/router/router';",
+        '',
+        `export default class ${className}Route extends Router {`,
+        '  constructor() {',
+        '    super();',
+        `    //! [GET] /${fileName} || Responsed OK`,
+        "    this.get('/', async (ctx) => {",
+        "      return ctx.send({ message: 'Ok' });",
+        '    });',
+        '  }',
+        '}',
+        '',
+    ].join('\n');
+}
+function serviceTemplate(className) {
+    return `export default class ${className}Service {}\n`;
+}
+function modelTemplate(className, fileName) {
+    return [
+        "import { Model, DataTypes, Sequelize } from 'sequelize';",
+        '',
+        `export type ${className}ModelType = {`,
+        '  id: string;',
+        '  message: string;',
+        '};',
+        '',
+        `export default class ${className} extends Model {`,
+        '  static initialize(sequelize: Sequelize) {',
+        `    ${className}.init(`,
+        '      {',
+        '        id: {',
+        '          type: DataTypes.STRING,',
+        '          primaryKey: true,',
+        '        },',
+        '        message: {',
+        '          type: DataTypes.STRING,',
+        '          allowNull: false,',
+        '        },',
+        '      },',
+        '      {',
+        '        sequelize,',
+        `        tableName: '${fileName}',`,
+        '        timestamps: false,',
+        '        indexes: [',
+        '          {',
+        '            unique: true,',
+        "            fields: ['message'],",
+        '          },',
+        '        ],',
+        '      },',
+        '    );',
+        '  }',
+        '}',
+        '',
+    ].join('\n');
+}
+async function writeNewFile(filePath, content) {
+    try {
+        await fs_1.promises.access(filePath);
+        throw new Error(`File already exists: ${path_1.default.relative(process.cwd(), filePath)}`);
+    }
+    catch (error) {
+        if (error instanceof Error && error.message.startsWith('File already exists:'))
+            throw error;
+    }
+    await fs_1.promises.mkdir(path_1.default.dirname(filePath), { recursive: true });
+    await fs_1.promises.writeFile(filePath, content, 'utf8');
+}
+async function isFlutryProject(projectRoot) {
+    try {
+        await Promise.all([
+            fs_1.promises.access(path_1.default.join(projectRoot, 'package.json')),
+            fs_1.promises.access(path_1.default.join(projectRoot, 'src', 'package', 'router', 'router.ts')),
+        ]);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+async function generate(type, name) {
+    const projectRoot = process.cwd();
+    if (!(await isFlutryProject(projectRoot))) {
+        console.error('This command can only be used inside a Flutry project.');
+        return;
+    }
+    const { fileName, className } = normalizeName(name);
+    const sourceRoot = path_1.default.join(projectRoot, 'src');
+    const spinner = (0, ora_1.default)({
+        text: type === 'route' ? chalk_1.default.cyan(`Generating route ${fileName}`) : chalk_1.default.magenta(`Generating model ${fileName}`),
+        spinner: 'dots12',
+        color: type === 'route' ? 'cyan' : 'magenta',
+    }).start();
+    try {
+        if (type === 'route') {
+            const routeDirectory = path_1.default.join(sourceRoot, 'routes', fileName);
+            spinner.text = chalk_1.default.cyan(`Creating ${fileName}.route.ts`);
+            await writeNewFile(path_1.default.join(routeDirectory, `${fileName}.route.ts`), routeTemplate(className, fileName));
+            spinner.text = chalk_1.default.blue(`Creating ${fileName}.service.ts`);
+            await writeNewFile(path_1.default.join(routeDirectory, `${fileName}.service.ts`), serviceTemplate(className));
+            spinner.succeed(chalk_1.default.greenBright(`✦ Route generated: src/routes/${fileName}/`));
+            return;
+        }
+        spinner.text = chalk_1.default.magenta(`Creating ${fileName}.model.ts`);
+        await writeNewFile(path_1.default.join(sourceRoot, 'models', `${fileName}.model.ts`), modelTemplate(className, fileName));
+        spinner.succeed(chalk_1.default.greenBright(`✦ Model generated: src/models/${fileName}.model.ts`));
+    }
+    catch (error) {
+        spinner.fail(chalk_1.default.red(`Could not generate ${type} ${fileName}`));
+        throw error;
+    }
+}
+async function generateRoute(name) {
+    try {
+        await generate('route', name);
+    }
+    catch (error) {
+        console.error(`${chalk_1.default.redBright('✖')} ${error instanceof Error ? error.message : 'Route generation failed.'}`);
+        process.exitCode = 1;
+    }
+}
+async function generateModel(name) {
+    try {
+        await generate('model', name);
+    }
+    catch (error) {
+        console.error(`${chalk_1.default.redBright('✖')} ${error instanceof Error ? error.message : 'Model generation failed.'}`);
+        process.exitCode = 1;
+    }
+}

package/dist/commands/new.d.ts

@@ -0,0 +1,17 @@
+type PackageManager = 'npm' | 'yarn' | 'pnpm';
+type Answers = {
+    folderName: string;
+    projectName: string;
+    database: boolean;
+    dbName: string;
+    dbUser: string;
+    dbPass: string;
+    dbHost: string;
+    dbPort: string;
+    dbType: 'mysql' | 'mariadb';
+    packageManager: PackageManager;
+    installNow: boolean;
+};
+export declare function promptQuestions(): Promise<Answers>;
+export default function newCommand(): Promise<void>;
+export {};

package/dist/commands/new.js

@@ -0,0 +1,190 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptQuestions = promptQuestions;
+exports.default = newCommand;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = require("fs");
+const path_1 = __importDefault(require("path"));
+const child_process_1 = require("child_process");
+const chalk_1 = __importDefault(require("chalk"));
+const degit_1 = __importDefault(require("degit"));
+const ora_1 = __importDefault(require("ora"));
+const prompts_1 = require("@inquirer/prompts");
+const DEFAULTS = {
+    port: '1337',
+    host: '0.0.0.0',
+    dbPort: '3306',
+    dbType: 'mariadb',
+};
+async function promptQuestions() {
+    console.log(`\n${chalk_1.default.cyanBright('╭────────────────────────────────────╮')}`);
+    console.log(`${chalk_1.default.cyanBright('│')} ${chalk_1.default.bold.white('✦ FLUTRY')} ${chalk_1.default.gray('project generator')} ${chalk_1.default.cyanBright('│')}`);
+    console.log(`${chalk_1.default.cyanBright('╰────────────────────────────────────╯')}`);
+    console.log(chalk_1.default.gray('  Create a clean project with a few focused choices.\n'));
+    const folderName = await (0, prompts_1.input)({
+        message: `${chalk_1.default.cyan('📁')} Project folder:`,
+        validate: (value) => validateFolderName(value) || 'Enter a folder name without / or \\.',
+    });
+    const projectName = await (0, prompts_1.input)({
+        message: `${chalk_1.default.blue('📦')} Package name:`,
+        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 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 }),
+            dbType: await (0, prompts_1.select)({
+                message: `${chalk_1.default.yellow('◈')} Database type:`,
+                choices: [
+                    { name: 'MariaDB', value: 'mariadb' },
+                    { name: 'MySQL', value: 'mysql' },
+                ],
+                default: DEFAULTS.dbType,
+            }),
+        }
+        : {
+            dbName: '',
+            dbUser: '',
+            dbPass: '',
+            dbHost: '',
+            dbPort: '',
+            dbType: DEFAULTS.dbType,
+        };
+    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' },
+        ],
+        default: 'npm',
+    });
+    return {
+        folderName,
+        projectName,
+        database,
+        ...databaseAnswers,
+        packageManager,
+        installNow: await (0, prompts_1.confirm)({ message: `${chalk_1.default.green('⚡')} Install dependencies now?`, default: true }),
+    };
+}
+function buildEnv(answers, example) {
+    const secret = (name) => (example ? `your_${name.toLowerCase()}` : crypto_1.default.randomBytes(64).toString('hex'));
+    return [
+        '# Server',
+        `PORT=${DEFAULTS.port}`,
+        `HOST=${DEFAULTS.host}`,
+        'PREFIX_API=',
+        '# Database',
+        `DB=${answers.database ? 'true' : 'false'}`,
+        `DB_NAME=${example ? '' : answers.dbName}`,
+        `DB_USER=${example ? '' : answers.dbUser}`,
+        `DB_PASS=${example ? '' : answers.dbPass}`,
+        `DB_HOST=${example ? '' : answers.dbHost}`,
+        `DB_PORT=${example ? '' : answers.dbPort}`,
+        `DB_TYPE=${answers.dbType}`,
+        '# 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 });
+}
+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();
+    try {
+        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);
+        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');
+        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'),
+            removeIfPresent(path_1.default.join(targetDir, '.gitattributes')),
+        ]);
+        await fs_1.promises.writeFile(path_1.default.join(targetDir, 'README.md'), `# ${answers.folderName}\n\nGenerated by Flutry CLI.\n`, 'utf8');
+        spinner.succeed(chalk_1.default.greenBright('Project created successfully'));
+        return targetDir;
+    }
+    catch (error) {
+        spinner.fail(chalk_1.default.red('Project creation failed'));
+        await removeIfPresent(targetDir);
+        throw error;
+    }
+}
+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();
+    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'] });
+        let errorOutput = '';
+        child.stderr.on('data', (data) => {
+            errorOutput += data.toString();
+        });
+        child.on('error', reject);
+        child.on('close', (code) => {
+            if (code === 0)
+                resolve();
+            else
+                reject(new Error(`${packageManager} install failed${errorOutput ? `: ${errorOutput.trim()}` : ''}`));
+        });
+    });
+    spinner.succeed(chalk_1.default.greenBright('Dependencies installed'));
+}
+async function exists(filePath) {
+    try {
+        await fs_1.promises.access(filePath);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function validateFolderName(value) {
+    return value.trim().length > 0 && value !== '.' && value !== '..' && !/[\\/]/.test(value);
+}
+function validatePort(value) {
+    return /^\d{1,5}$/.test(value) && Number(value) > 0 && Number(value) <= 65535 ? true : 'Enter a valid port (1-65535).';
+}
+function validatePackageName(name) {
+    return /^[a-z0-9]+(?:-[a-z0-9]+)*$/.test(name) ? true : 'Use lowercase letters, numbers and hyphens only.';
+}
+async function newCommand() {
+    try {
+        const answers = await promptQuestions();
+        const targetDir = await createProject(answers);
+        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)
+            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`);
+    }
+    catch (error) {
+        console.error(`\n${chalk_1.default.redBright('✖')} ${error instanceof Error ? error.message : 'Command failed.'}`);
+        process.exitCode = 1;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const new_1 = __importDefault(require("./commands/new"));
+const generate_1 = require("./commands/generate");
+commander_1.program.command('new').description('Create a new Flutry project').action(new_1.default);
+const generate = commander_1.program.command('generate').alias('g').description('Generate a route or model');
+generate.command('route <name>').description('Generate a route and service').action(generate_1.generateRoute);
+generate.command('model <name>').description('Generate a Sequelize model').action(generate_1.generateModel);
+commander_1.program.parse(process.argv);

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@flutry/cli",
+  "version": "1.0.0",
+  "description": "Flurty project scaffolding CLI",
+  "bin": {
+    "flurty": "dist/index.js"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "assets",
+    "README.md"
+  ],
+  "repository": "https://github.com/Flutry-HQ/cli.git",
+  "author": "HEDI <admin@otamoon.hu>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "tsc --watch"
+  },
+  "devDependencies": {
+    "@types/node": "^26.2.0",
+    "typescript": "^7.0.2"
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^7.8.4",
+    "chalk": "^4.1.2",
+    "commander": "^15.0.0",
+    "degit": "^2.8.4",
+    "ora": "^9.4.1"
+  }
+}