NEW

FastAPI .cursorrules prompt file guide

Code Style and Structure:

Follow PEP 8 guidelines for Python code style
Use meaningful variable and function names (snake_case for variables and functions, PascalCase for classes)
Keep functions small and focused on a single task
Use docstrings for modules, classes, and functions
Organize code into logical modules and packages
Use virtual environments for project isolation

Python-specific Conventions:

Prefer list comprehensions and generator expressions over map() and filter()
Use context managers (with statements) for resource management
Utilize decorators for cross-cutting concerns (e.g., logging, timing)
Leverage type hints for improved code readability and tooling support
Use f-strings for string formatting

Framework and API Development:

Use FastAPI as the primary framework for building high-performance APIs
Leverage FastAPI's automatic OpenAPI (Swagger) documentation
Utilize dependency injection for clean, testable code
Implement RESTful API design principles
Use Pydantic for data validation, serialization, and settings management
Define request and response models using Pydantic
Utilize Pydantic's BaseSettings for configuration management

Database and Data Modeling:

Use SQLModel, which combines SQLAlchemy core with Pydantic models
Leverage SQLModel's ability to use the same models for database tables and API schemas
Utilize SQLModel's async support for high-performance database operations
Implement database migrations using Alembic
Use connection pooling for efficient database connections
Implement proper indexing for frequently queried fields

Authentication and Security:

Implement JWT for stateless authentication
Use FastAPI's built-in security utilities
Use bcrypt for password hashing
Apply CORS policies using FastAPI's CORS middleware
Implement rate limiting for API endpoints (consider using FastAPI's dependencies for this)

Error Handling and Logging:

Use FastAPI's exception handlers for consistent error responses
Implement custom exception classes for application-specific errors
Use a logging framework (e.g., Python's built-in logging module)
Structure log messages for easy parsing and analysis

Frontend Development:

For server-side rendering, consider using FastAPI with Jinja2 templates
Implement responsive design using CSS frameworks (e.g., Bootstrap)
For single-page applications, use a JavaScript framework (e.g., React, Vue.js) that consumes your FastAPI backend

Testing:

Write unit tests using pytest
Implement integration tests for API endpoints using FastAPI's TestClient
Use factories (e.g., Factory Boy) for test data generation
Aim for high test coverage, especially for critical paths
Utilize Pydantic's parse_obj_as for easy test data creation

Asynchronous Processing:

Leverage FastAPI's asynchronous capabilities for concurrent processing
For background tasks, use FastAPI's background tasks feature or Celery for more complex scenarios
Implement message queues (e.g., RabbitMQ, Redis) for task management if needed

Deployment and DevOps:

Use Docker for containerization
Create optimized Dockerfiles for your FastAPI applications
Implement CI/CD pipelines (e.g., GitLab CI, GitHub Actions)
Use environment variables for configuration management
Utilize Pydantic's BaseSettings to load and validate environment variables
Implement health check endpoints for monitoring

Performance Optimization:

Leverage FastAPI's asynchronous capabilities for I/O-bound operations
Use caching mechanisms (e.g., Redis) for frequently accessed data
Implement database query optimization techniques with SQLModel
Profile code to identify and resolve bottlenecks

API Documentation:

Utilize FastAPI's automatic interactive API documentation (Swagger UI and ReDoc)
Keep API documentation up-to-date by maintaining accurate Pydantic models and FastAPI path operation functions

Version Control:

Use Git for version control
Implement feature branching and pull request workflows
Write meaningful commit messages

Dependencies Management

Use pip and requirements.txt for managing project dependencies
Consider using Poetry for more advanced dependency management

Remember to keep your code DRY (Don't Repeat Yourself), follow SOLID principles, and prioritize readability and maintainability in your Python full-stack development projects. Leverage the power of FastAPI, SQLModel, and Pydantic to create robust, type-safe, and high-performance applications.

stack:

FastAPI .cursorrules prompt file guide

Rohit Nair

NEW

JavaScript Chrome APIs .cursorrules prompt file

Cursor Rules for Chrome Extension Development

You are an expert in Chrome extension development, JavaScript, HTML, CSS, and Chrome APIs.

Code Style and Structure

Write concise, technical JavaScript code (ES6+) with accurate examples.
Use functional programming patterns; avoid classes unless necessary.
Prefer modular architecture to enhance maintainability and reusability.
Use descriptive variable names with auxiliary verbs (e.g., isLoading, hasError).
Structure extension files: manifest.json, background scripts, content scripts, popup HTML/JS/CSS, options page (if needed).

Naming Conventions

Use camelCase for variable and function names (e.g., getUserData, isExtensionActive).
Use PascalCase for constructor functions and classes.
Use uppercase with underscores for constants (e.g., MAX_RETRY_ATTEMPTS).

JavaScript Usage

Use modern JavaScript (ES6+) features, ensuring compatibility with the minimum supported Chrome version.
Implement proper error handling and input validation.
Use async/await for asynchronous operations when possible.

Chrome Extension Manifest

Use the latest manifest version (v3) unless there's a specific need for v2.
Properly declare permissions, host permissions, and content security policy.
Use declarative net request instead of the webRequest API where possible.

Extension Architecture

Separate concerns between background scripts, content scripts, and popup scripts.
Use message passing for communication between different parts of the extension.
Implement proper state management using Chrome's storage API.

User Interface and Styling

Create intuitive and responsive UI for popup and options pages.
Use CSS frameworks sparingly to keep the extension lightweight.
Implement dark mode support for better user experience.

Performance Optimization

Minimize resource usage in background scripts.
Use event pages instead of persistent background pages when possible.
Optimize content scripts to minimize impact on web page performance.

Security Practices

Implement content security policies to prevent XSS attacks.
Use Chrome's identity API for secure authentication.
Sanitize and validate all user inputs.

API Usage

Utilize Chrome extension APIs effectively (e.g., chrome.tabs, chrome.storage, chrome.runtime).
Implement proper error handling for Chrome API calls.
Use Chrome's alarms API for scheduling tasks instead of setInterval.

Development Process

Start by outlining the extension's functionality and required components.
Create the manifest.json file with necessary permissions and configurations.
Develop background scripts for core functionality and event handling.
Create content scripts for page manipulation (if required).
Design and implement popup UI and functionality.
Develop options page for user-configurable settings (if needed).
Implement message passing between different components.
Write necessary CSS for styling popup and options pages.
Test the extension thoroughly in different scenarios.

Internationalization

Use Chrome's i18n API for multi-language support.
Externalize user-facing strings in _locales folder.

Testing and Debugging

Use Chrome's developer tools for debugging (especially the dedicated panels for service workers and extensions).
Implement unit tests using frameworks like Jest.
Perform cross-browser testing if aiming for compatibility with other Chromium-based browsers.

Publishing

Prepare a detailed description, screenshots, and promotional tiles for the Chrome Web Store.
Create a privacy policy and terms of service if handling user data.
Follow Chrome Web Store's best practices and policies for successful submission.

Example Extensions
You can reference these example extensions: