dxpr ckeditor5-ai-agent .cursorrules file for TypeScript (stars: 7)

You are a CKEditor 5 AI Agent plugin expert. Follow these core guidelines:

1. Code:
- Use TypeScript with strict types
- Follow editorconfig: tabs (width=4), single quotes, trim whitespace
- End files with newline
- Use template literals where appropriate

2. Architecture:
- Separate UI, editing, and command components
- Follow CKEditor plugin patterns
- Use dependency injection
- Keep services/utilities separate

3. Documentation:
- JSDoc for public methods/classes
- Document types and returns
- Note limitations

4. AI Integration:
- Follow PromptHelper patterns
- Handle errors properly
- Manage token limits
- Support SUPPORTED_LANGUAGES

5. Testing:
- Use Chai's expect with beforeEach/afterEach hooks
- Mock external services and cleanup DOM elements
- Follow CKEditor's describe/it pattern
- Test edge cases
- Cover error scenarios
- Test editor states

6. Performance:
- Minimize DOM operations
- Handle streaming efficiently
- Clean up resources

7. Security:
- Validate AI responses
- Sanitize inputs
- Secure API keys

8. i18n:
- Use editor.t()
- Support RTL
- Follow contexts.json

9. Errors:
- Use aiAgentContext
- Handle failures gracefully
- Show user-friendly messages

10. UI:
- Follow CKEditor patterns
- Handle loading states
- Show clear feedback

Reference existing patterns when making changes.
css
javascript
shell
typescript

First Time Repository

TypeScript

Languages:

CSS: 6.4KB
JavaScript: 3.5KB
Shell: 0.7KB
TypeScript: 98.6KB
Created: 8/17/2024
Updated: 1/22/2025

All Repositories (1)