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 Cheat Sheet

A quick reference for the most commonly used features of the Flaxon VS Code Extension.

🚀 Commands

Open the Command Palette (Ctrl+Shift+P) and run:

⌨️ Keyboard Shortcuts

📁 Route Explorer

Displays all discovered routes.

Flaxon Routes
├── app.py
│   ├── GET /
│   ├── POST /login
│   └── GET /users
├── api.py
│   ├── GET /api/posts
│   └── POST /api/posts
└── admin.py
    └── GET /admin

Method Colors

⚡ CodeLens

Appears above route handlers.

@app.get("/users")
# ▶ Run    🐛 Debug    📍 References
async def get_users():
    ...

Available actions:

• ▶ Run
• 🐛 Debug
• 📍 Find References

💡 IntelliSense

Type:

@app.

Suggestions:

get
post
put
delete
patch
websocket

Other completions:

fields.

String
Integer
Float
Boolean
Email
Choice
UUID
DateTime

📝 Snippets

Example:

froute + Tab

↓

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

🔎 Hover Documentation

Hover over:

• @app.get
• @app.post
• Schema
• fields.StrField
• HTTPException

to view documentation.

🐛 Diagnostics

The extension checks for:

• Missing imports
• Missing app = Flaxon()
• Non-async route handlers
• Missing return values
• Missing WebSocket accept()
• Invalid schemas
• Invalid decorators

▶ Running Your App

Command Palette:

Flaxon: Run App

or

Ctrl+Shift+F5

🐞 Debugging

Run:

Flaxon: Debug App

Supports:

• Breakpoints
• Variable inspection
• Watch expressions
• Call stack
• Exceptions

🔧 Generate Code

Available generators:

• Project
• Route
• Schema
• Plugin

⚙️ Important Settings

{
    "flaxon.entryPoint": "app:app",
    "flaxon.enableRouteExplorer": true,
    "flaxon.enableCodeLens": true,
    "flaxon.enableDiagnostics": true,
    "flaxon.enableCompletions": true,
    "flaxon.debug.reload": true,
    "flaxon.snippets.enable": true
}

📊 Status Bar

📂 Supported Project Files

The extension activates automatically when it detects:

app.py
main.py
run.py
flaxon.py

🚀 Development Workflow

Create Project
      │
      ▼
Write Routes
      │
      ▼
Use Snippets
      │
      ▼
View Route Explorer
      │
      ▼
Run Application
      │
      ▼
Debug
      │
      ▼
Test
      │
      ▼
Commit

🛠 Troubleshooting

📦 Recommended Extensions

✅ Best Practices

• Keep Route Explorer open.
• Use snippets whenever possible.
• Save files frequently.
• Enable diagnostics.
• Restart the Language Server if IntelliSense stops.
• Use CodeLens to run and debug routes quickly.

Quick Reference

Happy coding with Flaxon! 🚀