sinatra-scaffold

Sinatra Scaffold Command

Scaffolds a new Sinatra application with modern project structure, testing framework, and deployment configuration.

Arguments

• $1: project-name (required) - Name of the project/application
• $2: type (optional) - Application type: classic, modular, or api (default: modular)
• $3: options (optional) - JSON string with configuration options:
  • testing: rspec or minitest (default: rspec)
  • database: sequel, activerecord, or none (default: sequel)
  • frontend: none, erb, or haml (default: erb)

Usage Examples

# Basic modular app with defaults
/sinatra-scaffold my-app

# Classic app with RSpec and no database
/sinatra-scaffold simple-app classic '{"testing":"rspec","database":"none","frontend":"erb"}'

# API-only app with Minitest and ActiveRecord
/sinatra-scaffold api-service api '{"testing":"minitest","database":"activerecord","frontend":"none"}'

# Full-featured modular app
/sinatra-scaffold webapp modular '{"testing":"rspec","database":"sequel","frontend":"haml"}'

Workflow

Step 1: Validate and Initialize

Actions:

1. Validate project name format (alphanumeric, hyphens, underscores)
2. Check if directory already exists
3. Parse and validate options JSON
4. Create project directory structure

Validation:

# Check project name
if [[ ! "$PROJECT_NAME" =~ ^[a-zA-Z0-9_-]+$ ]]; then
  echo "Error: Invalid project name. Use alphanumeric characters, hyphens, or underscores."
  exit 1
fi

# Check if directory exists
if [ -d "$PROJECT_NAME" ]; then
  echo "Error: Directory '$PROJECT_NAME' already exists."
  exit 1
fi

Step 2: Create Directory Structure

Classic Structure:

project-name/
├── app.rb
├── config.ru
├── Gemfile
├── Rakefile
├── config/
│   └── environment.rb
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── views/
│   ├── layout.erb
│   └── index.erb
├── spec/ or test/
└── README.md

Modular Structure:

project-name/
├── app/
│   ├── controllers/
│   │   ├── application_controller.rb
│   │   └── base_controller.rb
│   ├── models/
│   ├── services/
│   └── helpers/
├── config/
│   ├── environment.rb
│   ├── database.yml (if database selected)
│   └── puma.rb
├── config.ru
├── db/
│   └── migrations/
├── lib/
│   └── tasks/
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── views/
│   ├── layout.erb
│   └── index.erb
├── spec/ or test/
│   ├── spec_helper.rb
│   └── controllers/
├── Gemfile
├── Rakefile
├── .env.example
├── .gitignore
└── README.md