obsidian-steward / rules
Cursor rule85 starsChanged 6 months agoMITView on GitHub
When creating new files (.ts), functions, or updating the existing code.
We split this general-rule.mdc into the rules it gives an agent
9 rules. About 0 are common, 6 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 8
If a function has more than 4 arguments, make it a single argument as an object.
- Distinctive: line 9
Use 'for' loops instead of 'forEach' for iterating arrays.
- Distinctive: line 10
Use dot notation instead of destructuring for accessing object's fields.
- Very specific: line 11
If you generate hard-coded text or strings, you MUST define all languages for them in the src/i18n/locales folder, (Except those are system …
- Distinctive: line 12
Avoid casting variables as any
- Very specific: line 13
When defining properties for a class, define them directly in the constructor's parameters if feasible, for example: constructor(private …
- Very specific: line 14
Always put a vault.on('create') in the onLayoutReady callback, otherwise it triggers when opening the app: …
- Distinctive: line 15
Always write readable, maintainable, and reusable code.
- Distinctive: line 16
When finishing generation, no need to run build or test.
≈ “Common” is an estimate: at least 1 in 5 of the 6,350 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
---
description: When creating new files (.ts), functions, or updating the existing code.
globs:
alwaysApply: false
---
- Adopt the return early approach.
- If a function has more than 4 arguments, make it a single argument as an object.
- Use 'for' loops instead of 'forEach' for iterating arrays.
- Use dot notation instead of destructuring for accessing object's fields.
- If you generate hard-coded text or strings, you MUST define all languages for them in the `src/i18n/locales` folder, (Except those are system prompts, logging, or errors) and use them via the `t` method.
- Avoid casting variables as any
- When defining properties for a class, define them directly in the constructor's parameters if feasible, for example: `constructor(private plugin: Plugin)`.
- Always put a `vault.on('create')` in the onLayoutReady callback, otherwise it triggers when opening the app: `src/services/SkillService/SkillService.ts:51-61`
- Always write readable, maintainable, and reusable code.
- When finishing generation, no need to run build or test. Leave it for me to review.
Where files are headingNew Cursor rule files have more rules about planning and tracking tasks, and fewer about code style.
Of the Cursor rule files we read, the 3,978 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository5 other files it gives its agents.
- community-UDCs/Agents.mdAGENTS.md
- .cursor/rules/test-rule.mdcCursor rule
- flashcardSkill
- guardrailsSkill
- user-defined-commandSkill
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.