@mallardbay/cursor-rules 1.0.6 → 1.0.8

package/.cursor/backend/rules/backend.mdc

@@ -0,0 +1,89 @@
+---
+description:
+globs:
+alwaysApply: false
+---
+# Mallard Bay Backend Development Rules
+
+## Project Structure
+
+-   `src/` - Main source code directory
+    -   `gql/` - GraphQL types, models, and resolvers
+    -   `helpers/` - Utility functions (e.g., algolia.helpers.ts, entity-algolia.helpers.ts)
+    -   `config/` - Configuration files and environment variables
+    -   `database/` - Database related code (Firestore, Algolia)
+    -   `firebase/` - Firebase functions and triggers
+    -   `services/` - Business logic services
+    -   `middleware/` - Express middleware
+
+## Environment Setup
+
+-   Use dotenv-vault for environment management
+-   Never commit .env files to git
+-   Use different .env files for different environments (dev, test, prod)
+
+## Firebase Development
+
+-   Use Firestore emulator for local development
+-   Start emulator: `gcloud emulators firestore start --host-port=127.0.0.1:8080`
+-   Use Firebase Functions for serverless operations
+-   Keep Firebase functions in `src/firebase/functions/`
+-   Use proper error handling in Firebase functions, use `captureException` helper for it
+-   Follow Firebase security rules best practices
+
+## Algolia Integration
+
+-   Configure Algolia indices using `bin/db/setup-algolia.ts`
+-   Follow Algolia index settings in `src/database/algolia/*-index-settings.ts`
+-   Use proper searchable attributes and faceting
+-   Keep Algolia indexing logic in `src/helpers/algolia.helpers.ts`
+-   Follow Algolia query character limits (ALGOLIA_MAX_QUERY_CHARACTER = 512)
+-   Use proper error handling for Algolia operations
+
+## Testing
+
+-   Use Jest as the testing framework
+-   Place tests in `__tests__` directories
+-   Mock Algolia, and other network requests in tests
+-   Use `tests/setupTests.ts` for global test setup
+-   Use `tests/teardownTests.ts` for cleanup
+-   Use Jest coverage reporting in the CI but not locally
+
+## Code Style
+
+-   Use TypeScript for all new code
+-   Follow ESLint rules from `@mallardbay/eslint-config-mallardbay`
+-   Follow existing codebase patterns
+-   Rely heavily on constants
+-   Copy should be in copy constants
+
+## GraphQL
+
+-   Define gql types, resolvers and mutations in `[ENTITY].schema.ts` files
+
+## Error Handling
+
+-   Use proper error types
+-   Log errors appropriately
+-   Handle edge cases
+-   Provide meaningful error messages
+-   Use try-catch blocks where appropriate
+-   Use Sentry for error tracking, use `captureException` helper for it
+
+## Performance
+
+-   Optimize Firestore queries
+-   Use proper indexing (see `firebase/firestore.indexes.json`)
+-   Cache when appropriate
+-   Monitor performance
+-   Setup new queries with pagination
+-   Follow Algolia best practices for search
+
+## Security
+
+-   Validate all input
+-   Sanitize user data
+-   Use proper authentication
+-   Follow security best practices
+-   Keep dependencies secure
+-   Use environment variables for sensitive data

package/README.md

@@ -4,10 +4,11 @@ A tool for managing Cursor IDE rules across different environment types with sha
 
 ## Overview
 
-This project provides a structured way to manage Cursor IDE rules for different development environments while maintaining a shared base configuration. It supports two main environment types:
+This project provides a structured way to manage Cursor IDE rules for different development environments while maintaining a shared base configuration. It supports three main environment types:
 
 -   `frontend`: Basic frontend development rules
 -   `frontend-lib`: Extended rules for frontend library development, inheriting from frontend rules
+-   `backend`: Backend development rules
 
 ## Installation
 
@@ -27,6 +28,7 @@ Where `<env-type>` can be either:
 
 -   `frontend`
 -   `frontend-lib`
+-   `backend`
 
 ### Example
 
@@ -36,6 +38,9 @@ npx @mallardbay/cursor-rules frontend
 
 # For frontend library development
 npx @mallardbay/cursor-rules frontend-lib
+
+# For backend development
+npx @mallardbay/cursor-rules backend
 ```
 
 ## Project Structure
@@ -48,8 +53,10 @@ The rules are organized in the following directory structure:
 │   └── rules/     # Shared base rules
 ├── frontend/
 │   └── rules/     # Frontend-specific rules
-└── frontend-lib/
-    └── rules/     # Frontend library-specific rules
+├── frontend-lib/
+│   └── rules/     # Frontend library-specific rules
+└── backend/
+    └── rules/     # Backend-specific rules
 ```
 
 ## Rule Inheritance
@@ -72,6 +79,7 @@ The rules follow an inheritance pattern:
 -   `.cursor/shared/rules/`: Shared base rules
 -   `.cursor/frontend/rules/`: Frontend-specific rules
 -   `.cursor/frontend-lib/rules/`: Frontend library-specific rules
+-   `.cursor/backend/rules/`: Backend-specific rules
 
 ## License
 

package/bin/setup-cursor.sh

@@ -17,6 +17,7 @@ SRC_DIR="$(cd "$(dirname "$SCRIPT_PATH")/.." && pwd)"
 SHARED_DIR="$SRC_DIR/.cursor/shared/rules"
 FRONTEND_DIR="$SRC_DIR/.cursor/frontend/rules"
 FRONTEND_LIB_DIR="$SRC_DIR/.cursor/frontend-lib/rules"
+BACKEND_DIR="$SRC_DIR/.cursor/backend/rules"
 
 mkdir -p .cursor/rules
 
@@ -36,6 +37,9 @@ case "$ENV_TYPE" in
   frontend)
     copy_rules "$FRONTEND_DIR"
     ;;
+  backend)
+    copy_rules "$BACKEND_DIR"
+    ;;
   frontend-lib)
     copy_rules "$FRONTEND_DIR"
     copy_rules "$FRONTEND_LIB_DIR"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mallardbay/cursor-rules",
-    "version": "1.0.6",
+    "version": "1.0.8",
     "description": "Mallard Bay shared cursor rules",
     "main": "bin/setup-cursor.sh",
     "repository": "git@github.com:mallardbay/cursor-rules.git",