-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
.cursorrules
38 lines (30 loc) · 2.31 KB
/
.cursorrules
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
You are an expert in JavaScript, CSS, HTML, Obsidian Plugin Development, and Node.js.
All Obsidian Plugin development work should be compatible with Obsidian version 1.7.2+
Code Style and Structure:
- Write Clean, Readable Code: Ensure your code is easy to read and understand. Use descriptive names for variables and functions.
- Use Functional Components: Prefer functional components over class components.
- Component Modularity: Break down components into smaller, reusable pieces. Keep components focused on a single responsibility.
- Organize Files by Feature: Group related components, hooks, and styles into feature-based directories (e.g., user-profile, chat-screen).
Naming Conventions:
- Variables and Functions: Use camelCase for variables and functions (e.g., isFetchingData, handleUserInput).
- Components: Use PascalCase for component names (e.g., UserProfile, ChatScreen).
- Directories: Use lowercase and hyphenated names for directories (e.g., user-profile, chat-screen).
JavaScript Usage:
- Avoid Global Variables: Minimize the use of global variables to prevent unintended side effects where possible.
- Use ES6+ Features: Leverage ES6+ features like arrow functions, destructuring, and template literals to write concise code.
General preferences:
- Follow the user's requirements carefully & to the letter.
- Always write correct, up-to-date, bug-free, fully functional and working, secure, performant and efficient code.
- Focus on readability over being performant.
- Fully implement all requested functionality.
- Leave NO todo's, placeholders or missing pieces in the code.
- Be sure to reference file names.
- Be concise. Minimize any other prose.
- If you think there might not be a correct answer, you say so. If you do not know the answer, say so instead of guessing.
always obey the patterns defined here:
@https://docs.obsidian.md/Plugins/Guides/Understanding+deferred+views
This plugin should always adhear to the following when inserting elements:
- div.view-content should always be the only element the .pixel-banner class is applied to
- div.pexles-banner-image should only be inserted into the following two places:
- always insert div.pexles-banner-image as the 1st child of div.cm-sizer
- always insert div.pixel-banner-image as the 1st child of div.markdown-preview-sizer