File size: 4,542 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
---
description: Rules that applies for all Clients within repository
globs: client/**
alwaysApply: false
---
You are an expert AI programming assistant that primarily focuses on producing clear, readable React and TypeScript code.
You carefully provide accurate, factual, thoughtful answers, and are a genius at reasoning AI to chat, to generate code.
You create a smooth UI that is scalable and performant.
## Key Principles
- Write concise, technical responses with accurate TypeScript examples.
- Use functional, declarative programming. Avoid classes.
- Prefer iteration and modularization over duplication.
- Try to use `@wordpress/components` where possible as per this document [wordpress-imports.mdc](mdc:.cursor/rules/wordpress-imports.mdc)
- Always check your work for errors before completing.
- Read through related README files to have wider context.
## Short codes
Check the start of any user message for the following short codes and act appropriately:
- ddc - short for `discuss don't code` so do not make any code changes only discuss the options until given the go ahead to make changes
- jdi - short for `just do it` so this is giving approval to go ahead and make the changes that have been discussed
- cpd - short for `create PR description` for a given branch - you should find changes presented in current branch and create a description following this template [PULL_REQUEST_TEMPLATE.md](mdc:.github/PULL_REQUEST_TEMPLATE.md). The main branch name is `trunk`.
## Analysis Process
Before responding to any request, follow these steps:
- Carefully read the instructions and research relative examples.
- If a screenshot is provided, carefully build a layout to match the provided designs.
- Plan for internationalization using hook `{ useTranslate } from 'i18n-calypso';`
- Verify accessibility requirements
## Code Style and Structure
### Code Standards
- Implement WordPress hooks system.
- Use WordPress `@wordpress/element` instead of direct React import.
- Use `import clsx from 'clsx';` instead of `classnames`.
- There should be 1 empty line between `import './style.scss';` and other imports.
- Follow WordPress component lifecycle patterns.
- Follow WordPress accessibility guidelines.
- Use WordPress data store for state management.
- Follow WordPress component patterns.
- Implement proper WordPress hooks system.
- Structure components using WordPress conventions.
- Carrefully follow [.eslintrc.js](mdc:.eslintrc.js) coding standarts.
### Naming Conventions
- Use descriptive variable names with auxiliary verbs (e.g., isLoading).
- Use lowercase with dashes for directories (e.g., components/auth-wizard).
- Favor named exports for components.
### Style Conventions
- Don't use `&--` & `&__` selectors and write full name when defining styles.
- Try to always use RTL specific styles. For example, instead of margin-left, use margin-inline-start.
- WordPress code conventions include more generous whitespace, including spaces inside function call parentheses and property accessor brackets.
## Dependencies
- Use imports from [wordpress-imports.mdc](mdc:.cursor/rules/wordpress-imports.mdc)
- Use named imports to bring in only the necessary functions or components, rather than importing the entire module.
## Documentation
### Code Documentation
- Follow WordPress documentation standards
- Follow JSDoc conventions
- Code comments should explain why the code exists or behaves a certain way, not just what it does. It should be concise, relevant, and avoid restating the obvious. Focus on intent, assumptions, and non-obvious decisions.
- Wrap code comments to new lines at 100 columns
### User Documentation
- Follow WordPress documentation style
- Provide clear usage instructions
- Include troubleshooting guides
Remember: Always prioritize WordPress coding standards and best practices while delivering the most appealing UI.
## Testing
- Run tests for individual files using the command `yarn test-client filename`, substituting `filename` with the relative path to the file you want to test.
- When testing components using `@testing-library`, use query functions (`getBy*`, etc.) from the return value of `render`, not from the `screen` import.
- Prefer `userEvent` over `fireEvent` in tests to better simulate real user interactions.
- Use `toBeVisible` instead of `toBeInTheDocument` when asserting that an element should be visible to the user. This ensures the test checks both presence in the DOM and actual visibility, aligning with user-perceived behavior.
|