diff --git a/content/en/ide_plugins/vscode/_index.md b/content/en/ide_plugins/vscode/_index.md index 2cd1b2c6db7..6246067555b 100644 --- a/content/en/ide_plugins/vscode/_index.md +++ b/content/en/ide_plugins/vscode/_index.md @@ -51,7 +51,7 @@ The extension includes these features: - [**View in IDE**](#view-in-ide): Jump directly from code references in Datadog to your source files. -- [**Code Security**](#code-security): Detect and fix security issues before you commit changes. +- [**Code Security**](#code-security): Detect and fix security issues before you commit, and write custom rules. - [**Exception Replay**](#exception-replay): Debug your production code. diff --git a/content/en/ide_plugins/vscode/code_security.md b/content/en/ide_plugins/vscode/code_security.md index 020e5b17d48..ae543fe0e8a 100644 --- a/content/en/ide_plugins/vscode/code_security.md +++ b/content/en/ide_plugins/vscode/code_security.md @@ -36,6 +36,21 @@ To analyze an entire folder or workspace, right-click a folder in the file explo
Static Code Analysis does not require a Datadog account, as source files are analyzed locally.
+### Rule editor + +Write and test [custom Static Code Analysis rules][4] without leaving your IDE. Use the rule editor to design detection logic for internal standards, security patterns, or maintainability checks specific to your codebase. + +{{< img src="/ide_plugins/vscode/static-analysis-rule-editor.png" alt="SAST rule editor in the Datadog extension for VS Code" style="width:100%;" >}} + +The rule editor provides the following panels. + +- A **Tree-sitter query editor** for pattern matching against the abstract syntax tree. +- A **JavaScript rule panel** for expressing detection logic and reporting violations. +- **Compliant and non-compliant test files** that run against the rule as you edit, with expected and actual match counts shown in real time. +- An **AST tree view** showing how the parser represents your test code. + +Import an existing rule from disk, or export a finished rule and upload it to Datadog. + ## Further reading {{< partial name="whats-next/whats-next.html" >}} @@ -43,3 +58,4 @@ To analyze an entire folder or workspace, right-click a folder in the file explo [1]: /security/code_security/static_analysis/ [2]: /security/code_security/static_analysis/static_analysis_rules/ [3]: https://github.com/DataDog/datadog-static-analyzer/blob/main/doc/legacy_config.md +[4]: /security/code_security/static_analysis/custom_rules/ diff --git a/static/images/ide_plugins/vscode/static-analysis-rule-editor.png b/static/images/ide_plugins/vscode/static-analysis-rule-editor.png new file mode 100644 index 00000000000..2a757390438 Binary files /dev/null and b/static/images/ide_plugins/vscode/static-analysis-rule-editor.png differ