.cursorrules (deprecated)
1/framework_rules/rules/nextjs-supabase-shadcn-pwa-cursorrules-prompt-file/.cursorrules.cursorrules
Quality
70/100
Scores the file, not the repository.Length
918 words
4 headings · 0 code blocksRepository
28
— · pushed 477 days agoLast changed
3 days ago
First indexed 3 days ago.1## Key Principles23- **Code Quality & Style**45 - Write concise, maintainable, and strongly typed code with accurate TypeScript implementations.6 - Embrace functional, declarative programming. Avoid OOP and classes.7 - Limit files to a maximum of 150 lines; refactor into smaller modules if exceeded.8 - Prefer iteration and modularization over duplication.9 - Use descriptive, semantic variable names with auxiliary verbs (e.g., `isLoading`, `hasError`).10 - Use lowercase with dashes for directories and files (e.g., `components/auth-wizard`).11 - Favor named exports for components.12 - Adopt RORO (Receive an Object, Return an Object) for function parameters/returns.13 - Always attain to use DRY (Don't Repeat Yourself) principles.14 - Conduct regular code reviews and frequent refactoring sessions to ensure consistency and quality.15 - Check and improve Web Vitals (LCP, CLS, FID) to maintain performance and user experience.1617- **Create 'Build Notes':**1819 - You must create a 'Build Notes' file for each task group to track the progress of the task group we work on.20 - **Clarity & Brevity:** Keep notes concise, direct, and focused on the task at hand.21 - **Logical Naming:** Use a consistent naming convention that ties each notes file to a specific task and date.22 - **Incremental Updates:** Update notes as plans evolve or tasks are completed. Append rather than overwrite.23 - **Traceability:** Ensure that each decision or change in approach is recorded and easy to follow.2425- **Review 'Project Contexts':**2627 - You must review the `projectContext.md` as we need to ensure that the project context is up to date and accurate.28 - **Stability:** Treat context files as stable references, not daily scratchpads.29 - **Selective Updates:** Update context files only when there are significant, approved changes to requirements or project scope.30 - **Accessibility:** Make context files easily understandable and organized so future developers can quickly grasp the project’s core guidance.3132- **Stack and Framework Conventions**3334 - Target **Next.js 15+** and leverage the App Router, React Server Components (RSC), and SSR capabilities.35 - Use Zustand for state management in client components when necessary.36 - Maintain proper Shadcn UI management using `npx shadcn@latest add` for new components.37 - Follow a mobile-first approach and responsive design patterns.38 - Emphasize server-side logic, minimizing the usage of `use client` and other client-only APIs.39 - Structure project as Progressive Web App (PWA) with offline capabilities, app-like experience, and installability across devices.4041- **Monorepo & Tooling**4243 - If using a monorepo structure, place shared code in a `packages/` directory and app-specific code in `app/`.44 - Use `Taskfile.yml` commands for development, testing, and deployment tasks.45 - Keep environment variables and sensitive data outside of code and access them through `.env` files or similar configuration.4647Below is a structured guideline to provide to the AI development agent, incorporating key principles and detailed rules for maintaining the `/ProjectDocs/Build_Notes/` and `/ProjectDocs/contexts/` directories.4849---5051### Rules for Build Notes Files52531. **Location & Naming:**5455 - Store all notes files in `/ProjectDocs/Build_Notes/`.56 - Use a logical, descriptive naming convention, e.g., `build-title_phase-#_task-group-name.md`.57 - Use the `<build-title>` to describe the build task.58 - Use the `<phase-#>` to apply the Phase # to the build task.59 - Use the `<task-group-name>` to describe the task group name.60 - Example: `supabase-schema-standardization_phase-1_preparation-and-code-analysis.md`61 - `supabase-schema-standardization` is the build title62 - `phase-1` is the phase number63 - `preparation-and-code-analysis` is the task group name64652. **Content Structure:**6667 - Begin with a brief **Task Objective** that summarizes what you aim to achieve.68 - Provide **Current State Assessment**: a short description of the current state of the project pertaining to the build tasks.69 - Provide **Future State Goal**: a short description of the future state of the project pertaining to the build tasks.70 - Follow with a **Implementation Plan**: a numbered list of **steps** containing checklist **tasks** to achieve the future state.71 - Update the **Implementation Plan** as tasks are completed and line out not applicable tasks. NEVER DELETE TASKS FROM THE PLAN.72 - If the plan changes or evolves, add new **steps** or **tasks**, rather than overwriting previous content.73743. **When to Update:**7576 - **At Task Start:** Create or open the task-specific notes file and record the initial plan before coding.77 - **During Task Execution:** Add updates when plans change, difficulties arise, or new insights emerge.78 - **At Task Completion:** Append a summary of what was done and verify it aligns with the original objective.79804. **Style & Tone:**8182 - Keep notes succinct, on-topic, and free of unrelated commentary.83 - Maintain a logical sequence so that future readers can understand the decision-making process without confusion.84855. **Completion of Build Notes:**8687 - Once the build notes are complete, move the file to the `/ProjectDocs/Build_Notes/completed/` directory.88 - If build notes are deprecated and no longer needed, move the file to the `/ProjectDocs/Build_Notes/archived/` directory.8990---9192### Rules for Context Files93941. **Master Project Context (`projectContext.md`):**9596 - Located in `/ProjectDocs/contexts/`.97 - Provides the overarching project scope, requirements, and design principles.98 - Only update this file if there are major changes to the project’s fundamental direction or scope.991002. **Additional Context Files:**101102 - Supplementary files (e.g., `uiContext.md`, `featureAContext.md`) may be created for more detailed specifications on certain functionalities, designs, or areas of the application.103 - Keep these files stable. Update them only when new, approved changes need to be documented.104 - Reference these files frequently to ensure development aligns with established guidelines.1051063. **Change Management:**107108 - Record any changes to context files within the corresponding build notes file for that task.109 - Maintain a clear rationale for context changes to preserve transparency and alignment with the core project goals.110111---112113## Project Structure114115Adopt a clear, modular directory structure:116117118
Also in paulpham157/paul-s-cursor-rules
Diff this repo’s formatsOne repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| paulpham157/paul-s-cursor-rules1/framework_rules/.cursorrules · 28 | .cursorrules | docs | 34/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/android-jetpack-compose-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testing-strategy | 38/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/angular-novo-elements-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testlint-formatstylearch+3 | 70/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/angular-typescript-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | teststyledocs | 38/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/ascii-simulation-game-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | no sections | 34/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/aspnet-abp-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testlint-formatstylearch+5 | 70/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/astro-typescript-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | git | 30/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/chrome-extension-dev-js-typescript-cursorrules-pro/.cursorrules · 28 | .cursorrules | style | 38/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/cpp-programming-guidelines-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | teststylearchperformance | 68/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/cursor-ai-react-typescript-shadcn-ui-cursorrules-p/.cursorrules · 28 | .cursorrules | no sections | 16/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/cursorrules-cursor-ai-nextjs-14-tailwind-seo-setup/.cursorrules · 28 | .cursorrules | styletypesuido-not | 65/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/cursorrules-cursor-ai-wordpress-draft-macos-prompt/.cursorrules · 28 | .cursorrules | no sections | 16/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/cursorrules-file-cursor-ai-python-fastapi-api/.cursorrules · 28 | .cursorrules | styletypes | 38/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/deno-integration-techniques-cursorrules-prompt-fil/.cursorrules · 28 | .cursorrules | no sections | 16/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/dragonruby-best-practices-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | style | 34/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/drupal-11-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | style | 46/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/elixir-engineer-guidelines-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | no sections | 16/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/elixir-phoenix-docker-setup-cursorrules-prompt-fil/.cursorrules · 28 | .cursorrules | git | 30/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/es-module-nodejs-guidelines-cursorrules-prompt-fil/.cursorrules · 28 | .cursorrules | docs | 39/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/flutter-app-expert-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testing-strategy | 38/100 | 3 days ago |
Diff against 1/framework_rules/.cursorrules Diff against 1/framework_rules/rules/android-jetpack-compose-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/angular-novo-elements-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/angular-typescript-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/ascii-simulation-game-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/aspnet-abp-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/astro-typescript-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/chrome-extension-dev-js-typescript-cursorrules-pro/.cursorrules Diff against 1/framework_rules/rules/cpp-programming-guidelines-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/cursor-ai-react-typescript-shadcn-ui-cursorrules-p/.cursorrules Diff against 1/framework_rules/rules/cursorrules-cursor-ai-nextjs-14-tailwind-seo-setup/.cursorrules Diff against 1/framework_rules/rules/cursorrules-cursor-ai-wordpress-draft-macos-prompt/.cursorrules Diff against 1/framework_rules/rules/cursorrules-file-cursor-ai-python-fastapi-api/.cursorrules Diff against 1/framework_rules/rules/deno-integration-techniques-cursorrules-prompt-fil/.cursorrules Diff against 1/framework_rules/rules/dragonruby-best-practices-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/drupal-11-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/elixir-engineer-guidelines-cursorrules-prompt-file/.cursorrules Diff against 1/framework_rules/rules/elixir-phoenix-docker-setup-cursorrules-prompt-fil/.cursorrules Diff against 1/framework_rules/rules/es-module-nodejs-guidelines-cursorrules-prompt-fil/.cursorrules Diff against 1/framework_rules/rules/flutter-app-expert-cursorrules-prompt-file/.cursorrules
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| SkeneTechnologies/skene-cookbook.cursorrules · 51 | .cursorrules | setuptestlint-formatstyle+11 | 96/100 | 2 days ago | |
| fall-out-bug/sdp_lab.cursorrules · 0 | .cursorrules | setupbuildtestlint-format+3 | 86/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/python-llm-ml-workflow-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testlint-formatstyletypes+4 | 80/100 | 3 days ago | |
| storybookjs/storybook.cursorrules · 91k | .cursorrules | teststylearchdo-not+1 | 78/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/flutter-riverpod-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | stylearchdo-notagent-behaviour | 71/100 | 3 days ago | |
| forem/forem.cursorrules · 23k | .cursorrules | teststyletypesdatabase+4 | 71/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/aspnet-abp-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testlint-formatstylearch+5 | 70/100 | 3 days ago | |
| paulpham157/paul-s-cursor-rules1/framework_rules/rules/angular-novo-elements-cursorrules-prompt-file/.cursorrules · 28 | .cursorrules | testlint-formatstylearch+3 | 70/100 | 3 days ago |
