Flaxon 0.3.0 and Teloce-Py 0.3.0 are available on PyPI. Release instructions are maintained on this site; source links identify the framework snapshot. Check version and upgrade guidance.

Framework source · Markdown

Flaxon VS Code Extension - Features Guide

Overview

The Flaxon VS Code Extension provides a comprehensive set of features to supercharge your Flaxon development workflow.

🔍 Route Explorer

What It Does

The Route Explorer displays all your Flaxon routes in a hierarchical tree view inside the VS Code Explorer sidebar, making it easy to navigate large projects.

How to Access

1. Open the Explorer sidebar (Ctrl+Shift+E).
2. Expand the Flaxon Routes section.

Features

Example Route Tree

Flaxon Routes
├── 📄 app.py
│   ├── GET  /                  (line 12)
│   ├── GET  /api/users         (line 22)
│   ├── POST /api/users         (line 30)
│   └── WS   /ws/chat           (line 45)
├── 📄 auth.py
│   ├── POST /api/auth/login    (line 8)
│   └── POST /api/auth/logout   (line 16)
└── 📄 admin.py
    └── GET  /admin             (line 10)

HTTP Method Colors

⚡ CodeLens

What It Does

CodeLens adds useful actions directly above your route handlers, allowing you to run, debug, or locate references without leaving the editor.

Features

Example

@app.get("/users/<int:user_id>")
# ▶ Run    🐛 Debug    📍 3 References
async def get_user(user_id: int):
    return {
        "id": user_id,
        "name": f"User {user_id}"
    }

Visual Layout

┌─────────────────────────────────────────────────────────────┐
│ @app.get("/users/<int:user_id>")                           │
│ ┌───────────────────────────────────────────────────────┐  │
│ │ ▶ Run │ 🐛 Debug │ 📍 3 References                  │  │
│ └───────────────────────────────────────────────────────┘  │
│ async def get_user(user_id: int):                         │
│     return {"id": user_id, "name": f"User {user_id}"}     │
└─────────────────────────────────────────────────────────────┘

💡 Intelligent Completions

What It Does

The extension provides intelligent auto-completion for Flaxon APIs, decorators, validation classes, exceptions, and request objects as you type.

Completion Categories

Example

Type:

@app.

Suggestions:

@app.get         - GET route decorator
@app.post        - POST route decorator
@app.put         - PUT route decorator
@app.delete      - DELETE route decorator
@app.patch       - PATCH route decorator
@app.websocket   - WebSocket route decorator

📝 Code Snippets

What They Do

Speed up development with built-in snippets for common Flaxon patterns.

Available Snippets

Example

Typing:

froute

Then pressing Tab generates:

@app.get("/api/users")
async def get_users(request):
    """Get all users."""
    return {
        "users": []
    }

🔎 Hover Documentation

What It Does

Hover over Flaxon APIs to view inline documentation, examples, and parameter descriptions.

Supported APIs

Example

@app.get("/users")
async def get_users():
    return {"users": []}

Hovering over @app.get displays:

Flaxon GET Route

@app.get("/path")
async def handler(request):
    return {"message": "Hello"}

Parameters

🏃 One-Click Run

What It Does

Run your Flaxon application with a single command directly from Visual Studio Code.

How to Use

1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS).
2. Run:

Flaxon: Run App

1. Your application starts automatically in the integrated terminal.

Features

Configuration

{
    "flaxon.entryPoint": "app:app",
    "flaxon.debug.reload": true
}

🐛 Integrated Debugging

What It Does

Debug Flaxon applications using the built-in Visual Studio Code debugger.

How to Use

1. Open the Command Palette.
2. Run:

Flaxon: Debug App

1. The debugger launches with your application.

Debugging Features

Debug Configuration

{
    "name": "Flaxon: Debug App",
    "type": "python",
    "request": "launch",
    "module": "flaxon",
    "args": [
        "run",
        "app:app"
    ],
    "console": "integratedTerminal"
}

🔧 Project Scaffolding

What It Does

Generate complete Flaxon projects and common project components with a few clicks.

Available Commands

Create Project Workflow

1. Enter the project name.
2. Choose the project location.
3. The extension generates a starter project containing:

project/
├── app.py
├── pyproject.toml
├── README.md
├── requirements.txt
└── .gitignore

Generate Route Workflow

1. Enter the route path.

Example:

/api/users

1. Select the HTTP method.

2. GET

3. POST
4. PUT
5. DELETE
6. PATCH

7. WebSocket

8. (Optional) Enter a route name.

The extension generates a route file with boilerplate code.

Generate Schema Workflow

1. Enter a schema name.

Example:

CreateUser

1. Add your fields.

For each field you can specify:

• Name
• Type
• Required status
• Default value
• Constraints (minimum, maximum, length, choices, etc.)

The extension generates the complete schema class automatically.

📊 Real-time Diagnostics

What It Does

Detects common Flaxon mistakes as you type and displays warnings or errors directly in the editor.

Diagnostics

Example

@app.get("/users")
def get_users():
    return {"users": []}

Diagnostics:

⚠ Route handler should be async.
⚠ Missing return type annotation.

🎨 Syntax Highlighting

What It Does

Provides syntax highlighting specifically designed for Flaxon applications.

Highlighted Elements

📋 Command Reference

Available Commands

⚙️ Configuration Settings

Available Settings

Example Configuration

{
    "flaxon.pythonPath": "python3.11",
    "flaxon.entryPoint": "main:app",
    "flaxon.enableRouteExplorer": true,
    "flaxon.enableCodeLens": true,
    "flaxon.enableDiagnostics": true,
    "flaxon.enableCompletions": true,
    "flaxon.trace.server": "verbose",
    "flaxon.debug.reload": true,
    "flaxon.snippets.enable": true
}

🎯 Best Practices

Recommended Workflow

1. Create a project.
2. Define your routes.
3. Use snippets and IntelliSense.
4. View routes in the Route Explorer.
5. Run the application.
6. Debug when needed.
7. Generate additional components using the scaffolding commands.

Tips

• ✅ Keep the Route Explorer open while developing.
• ✅ Use snippets to reduce repetitive code.
• ✅ Enable diagnostics for instant feedback.
• ✅ Use the debugger to investigate complex issues.
• ✅ Save files frequently to refresh routes automatically.

🐛 Troubleshooting

Common Issues

Checking Logs

1. Open the Output panel (Ctrl+Shift+U).
2. Select Flaxon from the dropdown.
3. Review any logged errors or warnings.

Reporting Issues

When opening an issue, include:

• VS Code version
• Operating system
• Python version
• Flaxon version
• Extension version
• Steps to reproduce the issue
• Output panel logs
• Screenshots (if applicable)

Happy coding with Flaxon! 🚀