create-scafty 1.0.0

package/README.md

@@ -0,0 +1,167 @@
+# 🚀 create-scafty
+
+A modern CLI to scaffold a backend API with **Express**, **TypeScript**, **ESLint**, and **Prettier** — instantly.
+
+---
+
+## ✨ Features
+
+- ⚡ Instant backend setup
+- 🟦 Optional TypeScript support
+- 🧹 ESLint (with import sorting)
+- 💅 Prettier configuration
+- 📁 Optional `src/` structure
+- 📦 Choose your package manager (npm / pnpm / yarn)
+- 🌐 Express API starter included
+- 🧱 Modular and scalable architecture
+
+---
+
+## 📦 Usage
+
+### 1. Create a new project
+
+```bash
+npm create scafty@latest
+```
+
+or
+
+```bash
+npx create-scafty
+```
+
+---
+
+### 2. Follow the prompts
+
+You’ll be asked to configure:
+
+- Project name
+- TypeScript support
+- ESLint setup
+- Import sorting
+- Prettier
+- `src/` directory
+- Package manager
+
+---
+
+### 3. Start development
+
+```bash
+cd your-project
+npm run dev
+```
+
+---
+
+## 📁 Generated Structure
+
+Example output:
+
+```bash
+your-project/
+├── src/
+│   └── index.ts / index.js
+├── package.json
+├── tsconfig.json (if TS selected)
+├── eslint.config.js (if enabled)
+├── .prettierrc (if enabled)
+```
+
+---
+
+## 🚀 Express Starter
+
+The generated project includes a minimal Express server:
+
+```ts
+app.get('/', (req, res) => {
+  res.json({ message: 'API running 🚀' });
+});
+```
+
+---
+
+## ⚙️ Requirements
+
+- Node.js >= 18
+- npm / pnpm / yarn
+
+---
+
+## 🛠 Development (for contributors)
+
+Clone the repo:
+
+```bash
+git clone <your-repo-url>
+cd create-scafty
+```
+
+Install dependencies:
+
+```bash
+npm install
+```
+
+Build the CLI:
+
+```bash
+npm run build
+```
+
+Test locally:
+
+```bash
+npm link
+create-scafty
+```
+
+---
+
+## 📦 Publishing
+
+```bash
+npm run build
+npm publish --access public
+```
+
+---
+
+## 🧠 Roadmap
+
+- [ ] CLI flags (`--ts`, `--eslint`)
+- [ ] Multiple templates (MVC, Clean Architecture)
+- [ ] Git initialization
+- [ ] Environment file generator
+- [ ] Plugin system
+
+---
+
+## 🤝 Contributing
+
+Pull requests are welcome!
+Feel free to open issues for suggestions or bugs.
+
+---
+
+## 📄 License
+
+MIT
+
+---
+
+## 💡 Inspiration
+
+Inspired by modern scaffolding tools like:
+
+- create-vite
+- create-next-app
+
+---
+
+## ⭐ Support
+
+If you like this project, give it a ⭐ on GitHub!

package/dist/cli.js

@@ -0,0 +1,45 @@
+import path from 'path';
+import fs from 'fs-extra';
+import { askQuestions } from './prompts.js';
+import { createProject } from './generators/project.js';
+import { setupTS } from './generators/ts.js';
+import { setupESLint } from './generators/eslint.js';
+import { setupPrettier } from './generators/prettier.js';
+import { createExpressApp } from './generators/express.js';
+import { installDeps } from './install.js';
+import { logSuccess, logError, logInfo } from './utils/logger.js';
+import { createManager } from './utils/createManager.js';
+const rootDir = process.cwd();
+async function main() {
+    try {
+        logInfo('\n🚀 Backend Project Setup\n');
+        const answers = await askQuestions();
+        const projectName = answers.name?.trim().replace(/\s+/g, '-').toLowerCase() || 'backend';
+        const projectDir = path.join(rootDir, projectName);
+        if (await fs.pathExists(projectDir)) {
+            logError('Folder already exists. Aborting.');
+            process.exit(1);
+        }
+        await createProject(projectDir, projectName, answers);
+        const depsKeyName = 'deps';
+        const devDepsKeyName = 'devDeps';
+        const depsManager = createManager(depsKeyName);
+        const devDepsManager = createManager(devDepsKeyName);
+        if (answers.typescript) {
+            await setupTS(projectDir, answers, depsManager, devDepsManager);
+        }
+        if (answers.eslint) {
+            await setupESLint(projectDir, answers, depsManager, devDepsManager);
+        }
+        if (answers.prettier) {
+            await setupPrettier(projectDir, answers, depsManager, devDepsManager);
+        }
+        await createExpressApp(projectDir, answers, depsManager, devDepsManager);
+        await installDeps(projectDir, answers, depsManager, devDepsManager);
+        logSuccess(`\n✅ Project created.\n`);
+    }
+    catch (err) {
+        logError(err.message);
+    }
+}
+main();

package/dist/generators/eslint.js

@@ -0,0 +1,66 @@
+import fs from 'fs-extra';
+import path from 'path';
+export async function setupESLint(projectDir, answers, deps, devDeps) {
+    devDeps.add('eslint');
+    devDeps.add('globals');
+    let config = `import js from "@eslint/js";
+import globals from "globals";
+import { defineConfig } from "eslint/config";`;
+    // TS support
+    if (answers.typescript) {
+        devDeps.add('typescript-eslint');
+        config += `
+import tseslint from "typescript-eslint";`;
+    }
+    // Import sort plugin
+    if (answers.importSort) {
+        devDeps.add('eslint-plugin-simple-import-sort');
+        config += `
+import simpleImportSort from "eslint-plugin-simple-import-sort";`;
+    }
+    config += `
+
+export default defineConfig([
+  js.configs.recommended,`;
+    // TS config
+    if (answers.typescript) {
+        config += `
+  ...tseslint.configs.recommended,`;
+    }
+    config += `
+  {
+    files: ["**/*.{js,ts}"],
+    languageOptions: {
+      globals: globals.node,
+    },
+    plugins: {`;
+    if (answers.importSort) {
+        config += `
+      "simple-import-sort": simpleImportSort,`;
+    }
+    config += `
+    },
+    rules: {`;
+    // TS vs JS rules
+    if (answers.typescript) {
+        config += `
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": "warn",`;
+    }
+    else {
+        config += `
+      "no-unused-vars": "warn",`;
+    }
+    // import sort rules
+    if (answers.importSort) {
+        config += `
+
+      "simple-import-sort/imports": "warn",
+      "simple-import-sort/exports": "warn",`;
+    }
+    config += `
+    }
+  }
+]);`;
+    await fs.writeFile(path.join(projectDir, 'eslint.config.js'), config);
+}

package/dist/generators/express.js

@@ -0,0 +1,25 @@
+import fs from 'fs-extra';
+import path from 'path';
+export async function createExpressApp(projectDir, answers, deps, devDeps) {
+    const srcPath = answers.srcDir ? path.join(projectDir, 'src') : projectDir;
+    await fs.mkdirp(srcPath);
+    const ext = answers.typescript ? 'ts' : 'js';
+    deps.add('express');
+    devDeps.add('@types/node');
+    devDeps.add('@types/express');
+    await fs.writeFile(path.join(srcPath, `index.${ext}`), `import express from 'express';
+
+const app = express();
+const PORT = process.env["PORT"] || 3586;
+
+app.use(express.json());
+
+app.get('/', (_, res) => {
+  res.json({ message: 'API running 🚀' });
+});
+
+app.listen(PORT, () => {
+  console.log(\`Server running at http://localhost:\${PORT}\`);
+});
+`);
+}

package/dist/generators/prettier.js

@@ -0,0 +1,27 @@
+import fs from 'fs-extra';
+import path from 'path';
+export async function setupPrettier(projectDir, answers, deps, devDeps) {
+    devDeps.add('prettier');
+    await fs.writeJSON(path.join(projectDir, '.prettierrc'), {
+        singleQuote: true,
+        semi: true,
+        tabWidth: 2,
+        useTabs: false,
+        trailingComma: 'es5',
+        printWidth: 80,
+        bracketSpacing: true,
+        bracketSameLine: false,
+    }, { spaces: 2 });
+    await fs.writeFile(path.join(projectDir, '.prettierignore'), `node_modules
+dist
+build
+*.min.js
+
+.next
+out
+
+*.config.ts
+*.config.js
+*.config.mjs
+`);
+}

package/dist/generators/project.js

@@ -0,0 +1,14 @@
+import fs from 'fs-extra';
+import path from 'path';
+export async function createProject(projectDir, name, answers) {
+    await fs.mkdirp(projectDir);
+    await fs.writeJSON(path.join(projectDir, 'package.json'), {
+        name,
+        version: '1.0.0',
+        type: 'module',
+        private: true,
+        scripts: {
+            dev: answers.typescript ? 'tsx src/index.ts' : 'node src/index.js',
+        },
+    }, { spaces: 2 });
+}

package/dist/generators/ts.js

@@ -0,0 +1,41 @@
+import fs from 'fs-extra';
+import path from 'path';
+export async function setupTS(projectDir, answers, deps, devDeps) {
+    devDeps.add('typescript');
+    devDeps.add('tsx');
+    await fs.writeFile(path.join(projectDir, 'tsconfig.json'), `{
+  "compilerOptions": {
+    /* Language and Environment */
+    "target": "ESNext",
+    ${answers.srcDir ? `"rootDir": "src",` : ''}
+    "outDir": "dist",
+    "types": ["node"],
+    
+    /* Modules */
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "verbatimModuleSyntax": true,
+    
+    /* Interop */
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+
+    /* Type Checking */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    /* Linting */
+    "erasableSyntaxOnly": true,
+    "noPropertyAccessFromIndexSignature": true,
+
+    /* Performance */
+    "skipLibCheck": true,
+  },
+  ${answers.srcDir ? `"include": ["src"],` : ''}
+  "exclude": ["node_modules", "dist"]
+}`);
+}

package/dist/index.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './cli.js';

package/dist/install.js

@@ -0,0 +1,19 @@
+import {} from './prompts.js';
+import { Manager } from './utils/createManager.js';
+import { run } from './utils/run.js';
+const registry = {
+    pnpm: 'pnpm add',
+    yarn: 'yarn add',
+    npm: 'npm i',
+};
+export async function installDeps(projectDir, answers, deps, devDeps) {
+    const cmd = registry[answers['packageManager']];
+    if (!cmd)
+        throw new Error(`Unknown package manager: ${answers['packageManager']}`);
+    const depsManager = deps.get();
+    const devDepsManager = devDeps.get();
+    if (depsManager.length)
+        run(`${cmd} ${depsManager.join(' ')}`, projectDir);
+    if (devDepsManager.length)
+        run(`${cmd} -D ${devDepsManager.join(' ')}`, projectDir);
+}

package/dist/prompts.js

@@ -0,0 +1,49 @@
+import inquirer, {} from 'inquirer';
+export const packageManagerList = ['pnpm', 'yarn', 'npm'];
+const questions = [
+    {
+        name: 'name',
+        type: 'input',
+        message: 'Project name:',
+        default: 'backend',
+    },
+    {
+        name: 'typescript',
+        type: 'confirm',
+        message: 'Use TypeScript?',
+        default: true,
+    },
+    {
+        name: 'eslint',
+        type: 'confirm',
+        message: 'Add ESLint?',
+        default: true,
+    },
+    {
+        name: 'importSort',
+        type: 'confirm',
+        message: 'Add import sorting?',
+        default: true,
+    },
+    {
+        name: 'prettier',
+        type: 'confirm',
+        message: 'Add Prettier?',
+        default: true,
+    },
+    {
+        name: 'srcDir',
+        type: 'confirm',
+        message: 'Create src folder?',
+        default: true,
+    },
+    {
+        name: 'packageManager',
+        type: 'list',
+        message: 'Select package manager:',
+        choices: packageManagerList,
+    },
+];
+export async function askQuestions() {
+    return inquirer.prompt(questions);
+}

package/dist/utils/createManager.js

@@ -0,0 +1,22 @@
+export class Manager {
+    manager = {};
+    key;
+    constructor(key) {
+        this.key = key;
+        this.manager[key] = [];
+    }
+    get() {
+        return this.manager[this.key] ?? [];
+    }
+    add(str) {
+        this.get().push(str);
+    }
+    remove(str) {
+        const arr = this.get();
+        const index = arr.indexOf(str);
+        if (index !== -1) {
+            arr.splice(index, 1);
+        }
+    }
+}
+export const createManager = (key) => new Manager(key);

package/dist/utils/logger.js

@@ -0,0 +1,5 @@
+import chalk from 'chalk';
+export const logInfo = (msg) => console.log(chalk.cyan(msg));
+export const logSuccess = (msg) => console.log(chalk.green(msg));
+export const logError = (msg) => console.log(chalk.red(msg));
+export const logWarning = (msg) => console.log(chalk.yellow(msg));

package/dist/utils/run.js

@@ -0,0 +1,4 @@
+import { execSync } from 'child_process';
+export function run(cmd, cwd) {
+    execSync(cmd, { stdio: 'inherit', cwd });
+}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "create-scafty",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "Scaffold Express backend with TS, ESLint, Prettier",
+  "bin": {
+    "create-scafty": "./dist/index.js",
+    "scafty": "./dist/index.js"
+  },
+  "keywords": [
+    "cli",
+    "scaffold",
+    "express",
+    "typescript"
+  ],
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsx src/cli.ts"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "fs-extra": "^11.3.4",
+    "inquirer": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^25.6.0",
+    "eslint": "^10.2.0",
+    "eslint-plugin-simple-import-sort": "^13.0.0",
+    "globals": "^17.5.0",
+    "prettier": "^3.8.2",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.1"
+  }
+}