Skip to content

Commit bd77e11

Browse files
committed
Create cursorrules
1 parent 91451e4 commit bd77e11

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

cursorrules

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Cursor Rules for jAlert jQuery Plugin
2+
3+
## Project Overview
4+
jAlert is a jQuery plugin for creating modals, popups, lightboxes, and alerts. It's built with ES6+ and transpiled to ES5 for maximum browser compatibility.
5+
6+
## Build & Test Commands
7+
- Build: `npm run build`
8+
- Test: `npm test`
9+
- E2E Tests: `npm run test:e2e`
10+
- All Tests: `npm run test:all`
11+
12+
## Required Checks for Every Change
13+
14+
### 1. Testing Requirements
15+
- Update tests if they are impacted by changes
16+
- Add tests for any new logic or functionality
17+
- Ensure all new features have proper test coverage
18+
19+
### 2. Documentation Requirements
20+
- Update index.html to maintain demos for each option
21+
- Document every setting and its default value
22+
- Update README.md for any development or release flow changes
23+
24+
### 3. Release Process
25+
- Rebuild the project before any release
26+
- Update CHANGELOG.md with new version details
27+
- Update README.md and index.html to reflect latest version
28+
29+
### 4. Compatibility & Quality
30+
- Maintain backwards compatibility with older versions
31+
- Ensure feature parity across versions
32+
- Recalculate package size and update README with correct numbers
33+
34+
### 5. Accessibility & Mobile
35+
- Consider accessibility in all changes (ARIA attributes, keyboard navigation)
36+
- Ensure mobile-friendliness and responsive design
37+
- Test touch interactions and mobile layouts
38+
39+
### 6. Code Quality
40+
- Follow best practices and DRY principles
41+
- Make code extendable and extensible
42+
- Use consistent coding standards
43+
44+
### 7. User Experience
45+
- Provide all options for user control
46+
- Ensure users don't feel trapped or limited by the plugin
47+
- Give users full flexibility to customize behavior
48+
49+
## Key Files
50+
- Main JS: dist/jAlert.min.js
51+
- Main CSS: dist/jAlert.min.css
52+
- Source: src/jAlert.js, src/jAlert.css
53+
- Tests: tests/unit/, tests/e2e/, tests/visual/
54+
55+
## Dependencies
56+
- jQuery >= 3.7.0 (peer dependency)
57+
- Node >= 14.0.0
58+
- NPM >= 6.0.0
59+
60+
## Browser Support
61+
- IE11+ (ES5 compatible)
62+
- Chrome 60+
63+
- Firefox 55+
64+
- Safari 12+
65+
- Edge 79+

0 commit comments

Comments
 (0)