Documentation

IDE Plugin — Configuration

Configure the VS Code extension via settings.json or codesentinel.json.

The extension is configured through VS Code's settings.json or, for project-level settings, through a codesentinel.json file in your repository root. Project-level settings override user-level settings.

VS Code settings

Open VS Code settings (⌘ ,) and search for *CodeSentinel*, or edit settings.json directly:

json

{
  // Enable or disable the extension
  "codesentinel.enabled": true,

  // Minimum severity to show inline. Options: "critical" | "high" | "medium" | "low"
  "codesentinel.severity.threshold": "medium",

  // Scan on every keystroke (true) or only on save (false)
  "codesentinel.scan.realtime": false,

  // Show inline decorations (coloured border + underline)
  "codesentinel.decorations.enabled": true,

  // Rule IDs to suppress globally
  "codesentinel.rules.exclude": [],

  // File glob patterns to never scan
  "codesentinel.ignore.patterns": [
    "**/node_modules/**",
    "**/dist/**",
    "**/*.test.ts"
  ]
}

Available settings

Setting	Type	Default	Description
codesentinel.enabled	boolean	true	Master on/off switch
codesentinel.severity.threshold	string	"medium"	Lowest severity shown inline
codesentinel.scan.realtime	boolean	false	Scan on every keystroke
codesentinel.decorations.enabled	boolean	true	Show inline decorations
codesentinel.rules.exclude	string[]	[]	Rule IDs to suppress
codesentinel.ignore.patterns	string[]	see defaults	Glob patterns to skip

Prefer codesentinel.json for team settings

Store shared rule exclusions and ignore patterns in codesentinel.json and commit it to your repository. This ensures every developer on your team scans with the same configuration.

Installation

Keyboard Shortcuts