@mallardbay/cursor-rules 1.0.4 → 1.0.6

package/.cursor/frontend/rules/ui.mdc

@@ -61,3 +61,10 @@ Ensure responsive and accessible design:
 
 ## File Patterns
 These rules apply to all TypeScript and TSX files in the project.
+
+## Components
+- Keep components small and focused on a single responsibility
+- Use functional components with hooks instead of class components
+- Prefer `export default function ImpersonationBox() {` over `function ImpersonationBox(): React.ReactElement | null {` when defining components
+
+

package/README.md

@@ -0,0 +1,78 @@
+# Cursor Rules
+
+A tool for managing Cursor IDE rules across different environment types with shared base configurations.
+
+## 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:
+
+-   `frontend`: Basic frontend development rules
+-   `frontend-lib`: Extended rules for frontend library development, inheriting from frontend rules
+
+## Installation
+
+```bash
+npm install @mallardbay/cursor-rules
+```
+
+## Usage
+
+To set up Cursor rules for your project, run:
+
+```bash
+npx @mallardbay/cursor-rules <env-type>
+```
+
+Where `<env-type>` can be either:
+
+-   `frontend`
+-   `frontend-lib`
+
+### Example
+
+```bash
+# For frontend development
+npx @mallardbay/cursor-rules frontend
+
+# For frontend library development
+npx @mallardbay/cursor-rules frontend-lib
+```
+
+## Project Structure
+
+The rules are organized in the following directory structure:
+
+```
+.cursor/
+├── shared/
+│   └── rules/     # Shared base rules
+├── frontend/
+│   └── rules/     # Frontend-specific rules
+└── frontend-lib/
+    └── rules/     # Frontend library-specific rules
+```
+
+## Rule Inheritance
+
+The rules follow an inheritance pattern:
+
+-   All environments include the shared base rules
+-   `frontend-lib` inherits rules from both `frontend` and `frontend-lib` directories
+
+## Development
+
+### Adding New Rules
+
+1. Create `.mdc` files in the appropriate rules directory
+2. Rules will be automatically copied to `.cursor/rules/` when running the setup script
+
+### Directory Structure
+
+-   `bin/setup-cursor.sh`: Main setup script
+-   `.cursor/shared/rules/`: Shared base rules
+-   `.cursor/frontend/rules/`: Frontend-specific rules
+-   `.cursor/frontend-lib/rules/`: Frontend library-specific rules
+
+## License
+
+[Add your license information here]

package/bin/setup-cursor.sh

@@ -1,6 +1,5 @@
 #!/usr/bin/env bash
-# setup-cursor.sh
-# Combine shared and env-specific MDC rules into .cursor/rules/
+# setup-cursor.sh — frontend & frontend-lib layering with shared base
 
 set -e
 
@@ -12,25 +11,39 @@ if [ -z "$ENV_TYPE" ]; then
   exit 1
 fi
 
-# Ensure we resolve relative to the package location (even when used via npx)
-SRC_DIR="$(cd "$(dirname "$0")/.." && pwd)"
-SHARED_DIR="$SRC_DIR/.cursor/shared/rules"
-ENV_DIR="$SRC_DIR/.cursor/$ENV_TYPE/rules"
-
-if [ ! -d "$SHARED_DIR" ]; then
-  echo "Shared rules directory not found: $SHARED_DIR"
-  exit 1
-fi
+SCRIPT_PATH="$(realpath "$0")"
+SRC_DIR="$(cd "$(dirname "$SCRIPT_PATH")/.." && pwd)"
 
-if [ ! -d "$ENV_DIR" ]; then
-  echo "Environment-specific rules directory not found: $ENV_DIR"
-  exit 1
-fi
+SHARED_DIR="$SRC_DIR/.cursor/shared/rules"
+FRONTEND_DIR="$SRC_DIR/.cursor/frontend/rules"
+FRONTEND_LIB_DIR="$SRC_DIR/.cursor/frontend-lib/rules"
 
 mkdir -p .cursor/rules
 
-# Copy shared and env-specific rules into local project
-cp "$SHARED_DIR"/*.mdc .cursor/rules/
-cp "$ENV_DIR"/*.mdc .cursor/rules/
-
-echo ".cursor/rules setup complete for '$ENV_TYPE'."
+copy_rules() {
+  local DIR="$1"
+  if [ -d "$DIR" ]; then
+    echo "Copying rules from: $DIR"
+    cp "$DIR"/*.mdc .cursor/rules/ 2>/dev/null || true
+  fi
+}
+
+# Always include shared rules
+copy_rules "$SHARED_DIR"
+
+# Inheritance handling
+case "$ENV_TYPE" in
+  frontend)
+    copy_rules "$FRONTEND_DIR"
+    ;;
+  frontend-lib)
+    copy_rules "$FRONTEND_DIR"
+    copy_rules "$FRONTEND_LIB_DIR"
+    ;;
+  *)
+    echo "Unknown environment type: $ENV_TYPE"
+    exit 1
+    ;;
+esac
+
+echo ".cursor/rules setup complete for '$ENV_TYPE'"

package/package.json

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

package/.cursor/lib/rules/ui.mdc

@@ -1,63 +0,0 @@
----
-description: Defines best practices for building consistent, maintainable, and responsive UI in Mallard Bay projects
-globs:
-alwaysApply: false
----
-# UI Development Standards
-
-## Theme Usage
-Use theme values consistently across all components:
-
-### Colors
-- Use theme colors instead of hardcoded values
-- Example: `theme.colors.primary` instead of `'#000000'`
-
-### Spacing
-- Use theme spacing values for margins and padding
-- Example: `theme.space[4]` instead of `'16px'`
-
-### Typography
-- Use theme typography settings for text styles
-- Example: `theme.fontSizes.md` instead of `'16px'`
-
-### Borders
-- Use theme border styles and radius values
-- Example: `theme.borders.sm` instead of `'1px solid'`
-
-## Component Structure
-Maintain clean and consistent component structure:
-
-### Nesting
-- Limit component nesting to maximum depth of 3
-- Keep component hierarchy readable and maintainable
-
-### Inline Styles
-- Limit inline styles to maximum of 2 per component
-- Prefer theme-based styling
-
-### Component Library
-- Use existing components in @mallardbay/lib-react-components, @mallardbay/lib-react-components is based off Crakra UI v2
-- If no component available in @mallardbay/lib-react-components, create one using Crakra UI and place it under src/components/shared/todo-lib-react-components/ to me moved later
-
-## Responsive Design
-Ensure responsive and accessible design:
-
-### Breakpoints
-- Use theme breakpoints for responsive design
-- Implement mobile-first approach
-
-### Spacing
-- Use responsive spacing values
-- Adapt layouts for different screen sizes
-
-### Animations
-- Use theme transition values for animations
-- Keep animations smooth and performant
-
-### Rendering
-- Optimize component rendering
-- Avoid unnecessary re-renders
-- Use React.memo and useMemo when appropriate
-
-## File Patterns
-These rules apply to all TypeScript and TSX files in the project.