🚀 Flint Dart - VS Code Extension

✨ Features

🎯 Smart Snippets

Accelerate your development with intelligent code snippets:

Snippet	Description	Preview
flintm	Generate Flint Model classes
flintc	Generate Controller classes
flintmw	Generate Middleware classes
flintswagger	Add Swagger documentation

🔍 Real-time Validation

Get instant feedback on your validation rules with intelligent error detection:

req.validate({
  "email": "required|email",        // ✅ Valid
  "password": "required|min:6",     // ✅ Valid  
  "name": "required|confirme"       // ❌ Shows error for typo
});

🛠️ Code Generation

Click the lightbulb 💡 to generate boilerplate code automatically:

• Constructors with required parameters
• copyWith methods for immutable classes
• JSON serialization (toMap, fromMap, toJson, fromJson)
• Complete model classes with table schemas

📚 Swagger Documentation

Generate beautiful API documentation with simple annotations:

/// @summary User registration endpoint
/// @auth bearer
/// @response 200 User created successfully
/// @response 400 Validation error
/// @body {"email": "string", "password": "string"}
app.post("/register", authController.register);

🚀 Quick Start

Installation

1. Install from VS Code Marketplace

   • Open VS Code
   • Go to Extensions (Ctrl+Shift+X)
   • Search for "Flint Dart"
   • Click Install

2. Or install manually

   code --install-extension eulogia-technologies.flintdart
   

Usage Examples

1. Generate a Model

// Type: flintm → Tab
class UserModel extends Model<UserModel> {
  @override
  String? id;
  String? name;
  String? email;
  // ... auto-generated table schema and methods
}

2. Generate JSON Methods

class User {
  final int id;
  final String name;
  // ↑ Click the lightbulb to generate:
  //   - Constructor
  //   - copyWith()
  //   - toMap()/fromMap()
  //   - toJson()/fromJson()
}

3. Add Swagger Documentation

// Type: flintswagger → Tab
/// @summary Get user by ID
/// @auth bearer
/// @response 200 User details
/// @param id path string required User ID
app.get("/users/:id", userController.show);

⚙️ Requirements

• VS Code: Version 1.60.0 or higher
• Dart SDK: Version 2.12 or higher
• Flint Dart Framework: Latest version

🎨 Extension Settings

This extension enhances your Flint Dart development without requiring additional configuration. All features work out of the box!

🔧 Commands

Access these commands via Command Palette (Ctrl+Shift+P):

🐛 Known Issues

• Validation may show false positives in complex nested structures
• Some code actions might not trigger in very large files

Found a bug? Report it here

📝 Release Notes

1.0.0

🎉 Initial Release!

• Flint Model, Controller, and Middleware snippets
• Real-time validation rule checking
• JSON serialization code generation
• Swagger documentation support
• Lightbulb actions for rapid development

🤝 Contributing

We welcome contributions! Here's how you can help:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

This extension is licensed under the MIT License.

🙏 Acknowledgments

• Flint Dart framework team
• VS Code extension community
• All our amazing users and contributors

Key improvements in this README:

🎨 Visual Appeal

• Beautiful badges and headers
• Clean table layouts
• Professional color scheme (Dart blue)
• Centered sections for better readability

📋 Structured Information

• Clear feature categorization
• Usage examples with code blocks
• Quick start guide for new users
• Command reference table

🚀 User-Focused

• Immediate value demonstration
• Step-by-step installation
• Practical examples
• Visual placeholders for screenshots

🔧 Professional Elements

• Contribution guidelines
• License information
• Issue reporting links
• Company branding

Next steps to make it even better:

• images/feature-model.png - Model generation demo
• images/feature-validation.png - Validation errors
• images/feature-code-actions.png - Lightbulb actions

2. Add animated GIFs showing the extension in action