code-style-guidelines

A set of coding rules for TypeScript projects, covering types, naming, comments, composition, logging, tests, and commit messages.

In plain words
What is it for?
Use it to guide TypeScript implementation, write clearer tests and comments, structure code, and format commits.
Why use it?
It keeps code and changes consistent across contributors, reducing unclear code and uneven review standards.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/rygwdn/obsidian-mcp-plugin/code-style-guidelines
Clone the repo
git clone --depth 1 https://github.com/rygwdn/obsidian-mcp-plugin

Made for: Cursor.

Per session 177 This file is loaded in full into every session.
When invoked 177 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00177 $0.00177
Opus 5 $0.00088 $0.00088
Sonnet 5 $0.00035 $0.00035
Haiku 4.5 $0.00018 $0.00018

Measured 2d ago against content hash 58408f63c10a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

code-style-guidelines scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.cursor/rules/code-style-guidelines.mdc · 23 lines

What it actually says

Code Style Guidelines

Follow these conventions for consistent code:

  • Use TypeScript with proper typing throughout
  • Avoid any types whenever possible
  • Follow the conventional commit format (feat:, fix:, refactor:, etc.)
  • Create meaningful tests with descriptive it() blocks
  • Use descriptive variable names.
  • Add comments only for complex logic, non-obvious decisions, or to explain "why" something is done if not immediately clear from the code.
  • Avoid comments that merely restate what the code does, or that become outdated quickly (e.g., comments tracking interactive changes during development).
  • Favor composition over inheritance
  • Use centralized logging via the logger utility
  • For testing, prefer inline snapshots where appropriate

See CLAUDE.md for additional style guidelines.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 23 lines · 177 tokens per session scan A 58408f63c10a

Subscribe to this mod's changes

code-style-guidelines is a cursor rule published in the GitHub repository rygwdn/obsidian-mcp-plugin (11 stars, last pushed 6mo ago), licensed MIT. It adds 177 tokens to every session, about $0.0009 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.