scaffy-tool 0.2.0 → 1.0.0

package/registry/php/laravel/v13/test/scaffold.test.js

@@ -0,0 +1,105 @@
+import { describe, it, expect, jest, beforeEach } from '@jest/globals';
+
+describe('Laravel v13 scaffold', () => {
+  let scaffold;
+  let mockUtils;
+
+  beforeEach(async () => {
+    const mod = await import('../scaffold.js');
+    scaffold = mod.default;
+
+    mockUtils = {
+      run: jest.fn().mockResolvedValue(),
+      runInProject: jest.fn().mockResolvedValue(),
+      setEnv: jest.fn(),
+      createFile: jest.fn(),
+      appendToFile: jest.fn(),
+      log: jest.fn(),
+      success: jest.fn(),
+      warn: jest.fn(),
+      error: jest.fn(),
+      title: jest.fn(),
+      step: jest.fn(),
+      divider: jest.fn(),
+    };
+  });
+
+  it('runs the laravel v13 installer', async () => {
+    await scaffold(
+      {
+        projectName: 'my-app',
+        starterKit: 'none',
+        database: 'sqlite',
+        docker: false,
+      },
+      mockUtils
+    );
+    expect(mockUtils.run).toHaveBeenCalledWith(
+      expect.stringContaining('laravel/laravel:^13.0 my-app')
+    );
+  });
+
+  it('installs breeze when selected', async () => {
+    await scaffold(
+      {
+        projectName: 'my-app',
+        starterKit: 'breeze',
+        database: 'sqlite',
+        docker: false,
+      },
+      mockUtils
+    );
+    expect(mockUtils.runInProject).toHaveBeenCalledWith(
+      'my-app',
+      expect.stringContaining('breeze')
+    );
+  });
+
+  it('installs jetstream when selected', async () => {
+    await scaffold(
+      {
+        projectName: 'my-app',
+        starterKit: 'jetstream',
+        database: 'sqlite',
+        docker: false,
+      },
+      mockUtils
+    );
+    expect(mockUtils.runInProject).toHaveBeenCalledWith(
+      'my-app',
+      expect.stringContaining('jetstream')
+    );
+  });
+
+  it('sets database env vars', async () => {
+    await scaffold(
+      {
+        projectName: 'my-app',
+        starterKit: 'none',
+        database: 'mysql',
+        docker: false,
+      },
+      mockUtils
+    );
+    expect(mockUtils.setEnv).toHaveBeenCalledWith(
+      'my-app',
+      expect.objectContaining({ DB_CONNECTION: 'mysql' })
+    );
+  });
+
+  it('installs sail when docker is true', async () => {
+    await scaffold(
+      {
+        projectName: 'my-app',
+        starterKit: 'none',
+        database: 'sqlite',
+        docker: true,
+      },
+      mockUtils
+    );
+    expect(mockUtils.runInProject).toHaveBeenCalledWith(
+      'my-app',
+      expect.stringContaining('sail')
+    );
+  });
+});

package/registry/php/symfony/plugin.json

@@ -0,0 +1,35 @@
+{
+  "name": "Symfony",
+  "alias": ["symfony"],
+  "language": "php",
+  "latest": "v7",
+  "versions": ["v7"],
+  "description": "High-performance PHP framework for web applications and APIs",
+  "requires": [
+    {
+      "tool": "php",
+      "checkCommand": "php --version",
+      "parseVersion": "PHP ([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "8.2.0",
+      "installGuide": {
+        "mac": "brew install php",
+        "linux": "sudo apt install php8.2",
+        "windows": "https://windows.php.net",
+        "docs": "https://php.net"
+      }
+    },
+    {
+      "tool": "composer",
+      "checkCommand": "composer --version",
+      "parseVersion": "Composer version ([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "2.0.0",
+      "installGuide": {
+        "mac": "brew install composer",
+        "linux": "sudo apt install composer",
+        "windows": "https://getcomposer.org/download",
+        "docs": "https://getcomposer.org"
+      }
+    }
+  ],
+  "maintainer": "community"
+}

package/registry/php/symfony/v7/questions.js

@@ -0,0 +1,32 @@
+export default [
+  {
+    type: 'list',
+    name: 'projectType',
+    message: 'Project type?',
+    choices: [
+      { name: 'Web App  — full stack with Twig, forms, ORM', value: 'webapp' },
+      { name: 'API      — REST API with Symfony skeleton', value: 'api' },
+      {
+        name: 'Microservice — minimal Symfony skeleton',
+        value: 'microservice',
+      },
+    ],
+  },
+  {
+    type: 'list',
+    name: 'database',
+    message: 'Database?',
+    choices: [
+      { name: 'MySQL', value: 'mysql' },
+      { name: 'PostgreSQL', value: 'postgresql' },
+      { name: 'SQLite', value: 'sqlite' },
+      { name: 'None', value: 'none' },
+    ],
+  },
+  {
+    type: 'confirm',
+    name: 'docker',
+    message: 'Include Docker config?',
+    default: false,
+  },
+];

package/registry/php/symfony/v7/scaffold.js

@@ -0,0 +1,86 @@
+export default async (answers, utils) => {
+  const { projectName, projectType, database, docker } = answers;
+
+  utils.title('Creating Symfony v7 Project');
+
+  // ─── Step 1: Install ───────────────────────────────────
+  utils.step(1, 'Running Symfony installer');
+
+  if (projectType === 'webapp') {
+    await utils.run(
+      `composer create-project symfony/website-skeleton:"7.*" ${projectName}`
+    );
+  } else {
+    await utils.run(
+      `composer create-project symfony/skeleton:"7.*" ${projectName}`
+    );
+  }
+
+  // ─── Step 2: API Platform ──────────────────────────────
+  if (projectType === 'api') {
+    utils.step(2, 'Installing API Platform');
+    await utils.runInProject(projectName, 'composer require api-platform/core');
+  }
+
+  // ─── Step 3: Database ──────────────────────────────────
+  if (database !== 'none') {
+    utils.step(3, 'Configuring database');
+    await utils.runInProject(projectName, 'composer require symfony/orm-pack');
+    await utils.runInProject(
+      projectName,
+      'composer require --dev symfony/maker-bundle'
+    );
+
+    const dsnMap = {
+      mysql: `mysql://root:password@127.0.0.1:3306/${projectName}?serverVersion=8.0`,
+      postgresql: `postgresql://root:password@127.0.0.1:5432/${projectName}?serverVersion=15`,
+      sqlite: `sqlite:///%kernel.project_dir%/var/data.db`,
+    };
+
+    await utils.setEnv(projectName, {
+      DATABASE_URL: dsnMap[database],
+    });
+  }
+
+  // ─── Step 4: Docker ────────────────────────────────────
+  if (docker) {
+    utils.step(4, 'Creating Docker config');
+
+    const dockerCompose = `version: '3.8'
+services:
+  php:
+    image: php:8.2-fpm
+    volumes:
+      - .:/var/www/html
+    ports:
+      - "9000:9000"
+${
+  database === 'mysql'
+    ? `  db:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: ${projectName}
+    ports:
+      - "3306:3306"`
+    : ''
+}
+${
+  database === 'postgresql'
+    ? `  db:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: ${projectName}
+    ports:
+      - "5432:5432"`
+    : ''
+}
+`;
+    await utils.createFile(`${projectName}/docker-compose.yml`, dockerCompose);
+  }
+
+  utils.success(`Symfony v7 project "${projectName}" created successfully!`);
+  utils.log(`  cd ${projectName}`);
+  utils.log(`  symfony server:start`);
+};

package/registry/python/django/plugin.json

@@ -0,0 +1,35 @@
+{
+  "name": "Django",
+  "alias": ["django"],
+  "language": "python",
+  "latest": "v5",
+  "versions": ["v5"],
+  "description": "High-level Python web framework for rapid development",
+  "requires": [
+    {
+      "tool": "python",
+      "checkCommand": "python3 --version",
+      "parseVersion": "Python ([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "3.10.0",
+      "installGuide": {
+        "mac": "brew install python",
+        "linux": "sudo apt install python3",
+        "windows": "https://python.org/downloads",
+        "docs": "https://python.org"
+      }
+    },
+    {
+      "tool": "pip",
+      "checkCommand": "pip3 --version",
+      "parseVersion": "pip ([0-9]+\\.[0-9]+)",
+      "minVersion": "22.0.0",
+      "installGuide": {
+        "mac": "brew install python",
+        "linux": "sudo apt install python3-pip",
+        "windows": "https://pip.pypa.io/en/stable/installation",
+        "docs": "https://pip.pypa.io"
+      }
+    }
+  ],
+  "maintainer": "community"
+}

package/registry/python/django/v5/questions.js

@@ -0,0 +1,24 @@
+export default [
+  {
+    type: 'list',
+    name: 'database',
+    message: 'Database?',
+    choices: [
+      { name: 'SQLite  — default, no setup needed', value: 'sqlite' },
+      { name: 'PostgreSQL', value: 'postgresql' },
+      { name: 'MySQL', value: 'mysql' },
+    ],
+  },
+  {
+    type: 'confirm',
+    name: 'restFramework',
+    message: 'Include Django REST Framework?',
+    default: false,
+  },
+  {
+    type: 'confirm',
+    name: 'docker',
+    message: 'Include Docker config?',
+    default: false,
+  },
+];

package/registry/python/django/v5/scaffold.js

@@ -0,0 +1,107 @@
+export default async (answers, utils) => {
+  const { projectName, database, restFramework, docker } = answers;
+
+  utils.title('Creating Django v5 Project');
+
+  // ─── Step 1: Install Django ────────────────────────────
+  utils.step(1, 'Installing Django');
+  await utils.run('pip3 install "django>=5.0,<6.0"');
+
+  // ─── Step 2: Create Project ────────────────────────────
+  utils.step(2, 'Creating Django project');
+  await utils.run(`django-admin startproject ${projectName}`);
+
+  // ─── Step 3: Database ──────────────────────────────────
+  if (database === 'postgresql') {
+    utils.step(3, 'Installing PostgreSQL driver');
+    await utils.runInProject(projectName, 'pip3 install psycopg2-binary');
+  }
+
+  if (database === 'mysql') {
+    utils.step(3, 'Installing MySQL driver');
+    await utils.runInProject(projectName, 'pip3 install mysqlclient');
+  }
+
+  // ─── Step 4: REST Framework ────────────────────────────
+  if (restFramework) {
+    utils.step(4, 'Installing Django REST Framework');
+    await utils.runInProject(projectName, 'pip3 install djangorestframework');
+
+    const settingsPath = `${projectName}/${projectName}/settings.py`;
+    await utils.appendToFile(
+      settingsPath,
+      `\n# Django REST Framework\nINSTALLED_APPS += ['rest_framework']\n`
+    );
+  }
+
+  // ─── Step 5: requirements.txt ──────────────────────────
+  utils.step(5, 'Generating requirements.txt');
+
+  const requirements = [`django>=5.0,<6.0`];
+  if (database === 'postgresql') requirements.push('psycopg2-binary');
+  if (database === 'mysql') requirements.push('mysqlclient');
+  if (restFramework) requirements.push('djangorestframework');
+
+  await utils.createFile(
+    `${projectName}/requirements.txt`,
+    requirements.join('\n') + '\n'
+  );
+
+  // ─── Step 6: Docker ────────────────────────────────────
+  if (docker) {
+    utils.step(6, 'Creating Docker config');
+
+    const dockerfile = `FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
+`;
+
+    const dockerCompose = `version: '3.8'
+services:
+  web:
+    build: .
+    ports:
+      - "8000:8000"
+    volumes:
+      - .:/app
+${
+  database === 'postgresql'
+    ? `  db:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: ${projectName}
+    ports:
+      - "5432:5432"`
+    : ''
+}
+${
+  database === 'mysql'
+    ? `  db:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: ${projectName}
+    ports:
+      - "3306:3306"`
+    : ''
+}
+`;
+
+    await utils.createFile(`${projectName}/Dockerfile`, dockerfile);
+    await utils.createFile(`${projectName}/docker-compose.yml`, dockerCompose);
+  }
+
+  utils.success(`Django v5 project "${projectName}" created successfully!`);
+  utils.log(`  cd ${projectName}`);
+  utils.log(`  python manage.py migrate`);
+  utils.log(`  python manage.py runserver`);
+};

package/registry/python/fastapi/plugin.json

@@ -0,0 +1,35 @@
+{
+  "name": "FastAPI",
+  "alias": ["fastapi"],
+  "language": "python",
+  "latest": "v1",
+  "versions": ["v1"],
+  "description": "Modern, fast Python web framework for building APIs",
+  "requires": [
+    {
+      "tool": "python",
+      "checkCommand": "python3 --version",
+      "parseVersion": "Python ([0-9]+\\.[0-9]+\\.[0-9]+)",
+      "minVersion": "3.10.0",
+      "installGuide": {
+        "mac": "brew install python",
+        "linux": "sudo apt install python3",
+        "windows": "https://python.org/downloads",
+        "docs": "https://python.org"
+      }
+    },
+    {
+      "tool": "pip",
+      "checkCommand": "pip3 --version",
+      "parseVersion": "pip ([0-9]+\\.[0-9]+)",
+      "minVersion": "22.0.0",
+      "installGuide": {
+        "mac": "brew install python",
+        "linux": "sudo apt install python3-pip",
+        "windows": "https://pip.pypa.io/en/stable/installation",
+        "docs": "https://pip.pypa.io"
+      }
+    }
+  ],
+  "maintainer": "community"
+}

package/registry/python/fastapi/v1/questions.js

@@ -0,0 +1,25 @@
+export default [
+  {
+    type: 'list',
+    name: 'database',
+    message: 'Database?',
+    choices: [
+      { name: 'None', value: 'none' },
+      { name: 'PostgreSQL — SQLAlchemy + Alembic', value: 'postgresql' },
+      { name: 'MySQL     — SQLAlchemy + Alembic', value: 'mysql' },
+      { name: 'SQLite    — SQLAlchemy + Alembic', value: 'sqlite' },
+    ],
+  },
+  {
+    type: 'confirm',
+    name: 'async',
+    message: 'Use async database drivers?',
+    default: true,
+  },
+  {
+    type: 'confirm',
+    name: 'docker',
+    message: 'Include Docker config?',
+    default: false,
+  },
+];

package/registry/python/fastapi/v1/scaffold.js

@@ -0,0 +1,180 @@
+export default async (answers, utils) => {
+  const { projectName, database, async: useAsync, docker } = answers;
+
+  utils.title('Creating FastAPI Project');
+
+  // ─── Step 1: Create project folder ────────────────────
+  utils.step(1, 'Creating project structure');
+  await utils.run(`mkdir ${projectName}`);
+  await utils.run(`mkdir ${projectName}/app`);
+
+  // ─── Step 2: Create virtual environment ───────────────
+  utils.step(2, 'Creating virtual environment');
+  await utils.runInProject(projectName, 'python3 -m venv venv');
+
+  // ─── Step 3: Install FastAPI + Uvicorn ────────────────
+  utils.step(3, 'Installing FastAPI and Uvicorn');
+  await utils.runInProject(
+    projectName,
+    'venv/bin/pip install "fastapi>=0.100.0" "uvicorn[standard]"'
+  );
+
+  // ─── Step 4: Database drivers ─────────────────────────
+  if (database !== 'none') {
+    utils.step(4, 'Installing database dependencies');
+    await utils.runInProject(
+      projectName,
+      'venv/bin/pip install sqlalchemy alembic'
+    );
+
+    if (database === 'postgresql') {
+      const driver = useAsync ? 'asyncpg' : 'psycopg2-binary';
+      await utils.runInProject(projectName, `venv/bin/pip install ${driver}`);
+    }
+
+    if (database === 'mysql') {
+      const driver = useAsync ? 'aiomysql' : 'mysqlclient';
+      await utils.runInProject(projectName, `venv/bin/pip install ${driver}`);
+    }
+
+    if (database === 'sqlite' && useAsync) {
+      await utils.runInProject(projectName, 'venv/bin/pip install aiosqlite');
+    }
+  }
+
+  // ─── Step 5: Generate main.py ─────────────────────────
+  utils.step(5, 'Generating application files');
+
+  const mainPy = `from fastapi import FastAPI
+
+app = FastAPI(title="${projectName}", version="0.1.0")
+
+
+@app.get("/")
+${useAsync ? 'async ' : ''}def root():
+    return {"message": "Hello from ${projectName}"}
+
+
+@app.get("/health")
+${useAsync ? 'async ' : ''}def health():
+    return {"status": "ok"}
+`;
+
+  await utils.createFile(`${projectName}/app/main.py`, mainPy);
+
+  // ─── Step 6: Generate database.py if needed ───────────
+  if (database !== 'none') {
+    const dsnMap = {
+      postgresql: useAsync
+        ? `postgresql+asyncpg://user:password@localhost/${projectName}`
+        : `postgresql+psycopg2://user:password@localhost/${projectName}`,
+      mysql: useAsync
+        ? `mysql+aiomysql://user:password@localhost/${projectName}`
+        : `mysql+mysqlclient://user:password@localhost/${projectName}`,
+      sqlite: useAsync
+        ? `sqlite+aiosqlite:///./data.db`
+        : `sqlite:///./data.db`,
+    };
+
+    const databasePy = `from sqlalchemy${useAsync ? '.ext.asyncio' : ''} import create_engine${useAsync ? ', AsyncSession' : ''}, sessionmaker
+from sqlalchemy.orm import DeclarativeBase
+
+DATABASE_URL = "${dsnMap[database]}"
+
+${
+  useAsync
+    ? `engine = create_engine(DATABASE_URL)
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)`
+    : `engine = create_engine(DATABASE_URL)
+SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)`
+}
+
+
+class Base(DeclarativeBase):
+    pass
+`;
+    await utils.createFile(`${projectName}/app/database.py`, databasePy);
+  }
+
+  // ─── Step 7: Generate __init__.py ─────────────────────
+  await utils.createFile(`${projectName}/app/__init__.py`, '');
+
+  // ─── Step 8: requirements.txt ─────────────────────────
+  utils.step(6, 'Generating requirements.txt');
+
+  const requirements = ['fastapi>=0.100.0', 'uvicorn[standard]'];
+
+  if (database !== 'none') {
+    requirements.push('sqlalchemy');
+    requirements.push('alembic');
+    if (database === 'postgresql')
+      requirements.push(useAsync ? 'asyncpg' : 'psycopg2-binary');
+    if (database === 'mysql')
+      requirements.push(useAsync ? 'aiomysql' : 'mysqlclient');
+    if (database === 'sqlite' && useAsync) requirements.push('aiosqlite');
+  }
+
+  await utils.createFile(
+    `${projectName}/requirements.txt`,
+    requirements.join('\n') + '\n'
+  );
+
+  // ─── Step 9: Docker ───────────────────────────────────
+  if (docker) {
+    utils.step(7, 'Creating Docker config');
+
+    const dockerfile = `FROM python:3.12-slim
+
+WORKDIR /app
+
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY . .
+
+EXPOSE 8000
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]
+`;
+
+    const dockerCompose = `version: '3.8'
+services:
+  web:
+    build: .
+    ports:
+      - "8000:8000"
+    volumes:
+      - .:/app
+${
+  database === 'postgresql'
+    ? `  db:
+    image: postgres:15
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: ${projectName}
+    ports:
+      - "5432:5432"`
+    : ''
+}
+${
+  database === 'mysql'
+    ? `  db:
+    image: mysql:8.0
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: ${projectName}
+    ports:
+      - "3306:3306"`
+    : ''
+}
+`;
+
+    await utils.createFile(`${projectName}/Dockerfile`, dockerfile);
+    await utils.createFile(`${projectName}/docker-compose.yml`, dockerCompose);
+  }
+
+  utils.success(`FastAPI project "${projectName}" created successfully!`);
+  utils.log(`  cd ${projectName}`);
+  utils.log(`  source venv/bin/activate`);
+  utils.log(`  uvicorn app.main:app --reload`);
+  utils.log(`  Docs: http://localhost:8000/docs`);
+};