Docs/Rules/Rules Overview

Rules Overview

All built-in VGuard rules.

VGuard ships with 35 built-in rules across 3 categories.

Security Rules (11)

RuleSeverityDescription
security/branch-protectionblockBlocks writes to protected branches
security/destructive-commandsblockBlocks dangerous shell commands
security/secret-detectionblockDetects API keys, tokens, passwords
security/prompt-injectionwarnDetects injection patterns in fetched content
security/dependency-auditwarnFlags suspicious package installations
security/env-exposureblockPrevents env variable leakage in client code
security/rls-requiredwarnEnsures Row Level Security on SQL tables
security/unsafe-evalblockBlocks eval(), new Function(), string setTimeout
security/no-hardcoded-urlswarnFlags hardcoded localhost and API URLs
security/xss-preventionwarnWarns about dangerouslySetInnerHTML, innerHTML, v-html
security/sql-injectionblockBlocks string-interpolated SQL queries

Quality Rules (15)

RuleSeverityDescription
quality/import-aliasesblockEnforces path aliases over deep relative imports
quality/no-use-client-in-pagesblockNo "use client" in Next.js pages/layouts
quality/naming-conventionsblockPascalCase components, use-prefixed hooks
quality/no-deprecated-apiblockCatches deprecated API usage
quality/anti-patternswarnCSS in Tailwind, inline styles, console.log
quality/no-console-logwarnDetects console.log in production code
quality/max-file-lengthwarnWarns when files exceed length threshold
quality/file-structurewarnComponents/hooks in correct directories
quality/hallucination-guardwarnVerifies imports exist on disk
quality/test-coveragewarnWarns when files have no tests
quality/dead-exportswarnDetects unused exports
quality/no-any-typewarnFlags any type usage in TypeScript
quality/error-handlingwarnWarns about empty catch blocks
quality/a11y-jsxwarnAccessibility checks: missing alt, onClick on divs
quality/magic-numbersinfoFlags numeric literals that should be constants

Workflow Rules (9)

RuleSeverityDescription
workflow/commit-conventionswarnConventional commit format
workflow/pr-reminderinfoReminds about unpushed work at session end
workflow/migration-safetywarnDangerous SQL patterns
workflow/review-gatewarnWarns on direct commits to main
workflow/todo-trackerinfoTracks TODO/FIXME comments
workflow/changelog-reminderinfoReminds to update CHANGELOG
workflow/format-on-saveinfoSuggests running formatter
workflow/branch-namingwarnEnforces branch naming conventions
workflow/lockfile-consistencywarnReminds to update lockfile after dependency changes