Qualimetry Ansible Analyzer - VS Code Plugin

A VS Code extension that provides real-time static analysis for Ansible playbooks and task files (.yml, .yaml) so developers can identify and fix quality issues before committing.

Powered by the same analysis engine as the Qualimetry Ansible Analyzer for SonarQube and the Qualimetry Ansible Analyzer for IntelliJ.

Features

75 rules covering YAML syntax, naming, safety, and best practices.
Real-time diagnostics — issues appear as you type, with squiggly underlines and Problems panel entries.
Configurable rules — override severity or disable rules; set rule-specific properties (e.g. max line length, max tasks per play).
Import from SonarQube — pull your Ansible quality profile (rules and severities) into workspace or user settings.
Rule keys match the SonarQube and IntelliJ plugins so editor and CI findings are consistent.

Rule categories

Category	Examples
YAML & Syntax	Valid YAML, schema compliance, key ordering, consistent indentation
Naming	Task names, variable names, role names, handler names
Security	No-log secrets, vault usage, HTTPS required, file permissions
Best Practices	Handler usage, tags required, FQCN, deprecated modules
Style	Line length, indentation, trailing whitespace, final newline
Complexity	Task count limits, play count, block size
Galaxy & Roles	Role structure, meta validation, galaxy metadata

Installation

From GitHub Releases

Download the latest .vsix from GitHub Releases, then install via Extensions: Install from VSIX... (Command Palette).

From Marketplace (when published)

Install the extension from the VS Code Marketplace and ensure Java 17+ is available.

Requirements

Java 17+ - The analyzer runs on a Java-based language server. Java is auto-detected from JAVA_HOME or PATH. To set the path explicitly:
```
{
  "ansibleAnalyzer.java.home": "C:\\path\\to\\java17"
}
```

Configuration

Settings are under the ansibleAnalyzer namespace:

Setting	Type	Default	Description
`ansibleAnalyzer.enabled`	boolean	`true`	Enable or disable the analyzer.
`ansibleAnalyzer.java.home`	string	`""`	Path to a Java 17+ installation. When empty, the extension uses `JAVA_HOME` or `PATH`.
`ansibleAnalyzer.rules`	object	`{}`	Per-rule configuration. List rules to override or replace the default set (see below).
`ansibleAnalyzer.rulesReplaceDefaults`	boolean	`false`	When `true`, only the rules listed in `ansibleAnalyzer.rules` run (e.g. after Import from SonarQube). When `false`, listed rules are overrides and unlisted rules use the extension default profile.

How to customize rules

You can either override a few rules on top of the default profile, or replace the active set entirely (e.g. after importing from SonarQube).

Override mode (default) – Set ansibleAnalyzer.rulesReplaceDefaults to false or omit it. Add only the rule IDs you want to change (e.g. severity or enabled); all other rules use the extension default. You do not need to list all rules.
Replace mode – Set ansibleAnalyzer.rulesReplaceDefaults to true. Only the rules listed in ansibleAnalyzer.rules run. Use this when you have imported a profile from SonarQube or maintain your own full list.
Full default – Omit ansibleAnalyzer.rules or set it to {} with rulesReplaceDefaults false to use the built-in default profile.
After an upgrade – Entries for removed or renamed rules are ignored; you can delete them to tidy up.

Each rule can have enabled, severity (blocker | critical | major | minor | info), and rule-specific properties (e.g. maxLength, maxTasks).

Example `settings.json`

{
  "ansibleAnalyzer.enabled": true,
  "ansibleAnalyzer.java.home": "",
  "ansibleAnalyzer.rulesReplaceDefaults": false,
  "ansibleAnalyzer.rules": {
    "qa-max-line-length": {
      "enabled": true,
      "severity": "minor",
      "maxLength": "120"
    },
    "qa-task-name-min-chars": {
      "enabled": false
    }
  }
}

Aligning with a SonarQube quality profile

Use the command Ansible: Import rules from SonarQube (Command Palette). Enter your SonarQube server URL, the Ansible quality profile name or key, and a token if required. The extension fetches the profile's active rules and severities and writes them to ansibleAnalyzer.rules and sets ansibleAnalyzer.rulesReplaceDefaults to true, so only those rules run (matching your SonarQube profile).

The last-used URL and profile are remembered (in the extension's global state, not in settings), and the token (if provided) is stored securely in VS Code's secret storage. After a first successful import, the extension automatically re-syncs rules from the same server and profile each time it starts, so profile changes in SonarQube propagate without a manual re-import. Set ansibleAnalyzer.sonar.autoSyncOnStartup to false to disable this. To switch back to the extension default and only override a few rules, set ansibleAnalyzer.rulesReplaceDefaults to false.

Also available

The same analysis engine powers plugins for other platforms:

SonarQube plugin — enforce quality gates in CI/CD pipelines.
IntelliJ plugin — real-time analysis in JetBrains IDEs and Qodana CI/CD.

Rule keys and severities align across all three tools so findings are directly comparable.

Building from source

Prerequisites

JDK 17+ and Maven 3.6+
Node.js and npm

Build steps

Build the Java modules (analyzer + LSP server):

mvn clean package -pl ansible-lsp-server -am -DskipTests

Build the VS Code client:

cd vscode-client
npm install
npm run compile

Package as VSIX (copy LSP JAR into client, then package):

mkdir -p vscode-client/server
cp ansible-lsp-server/target/ansible-lsp-server-*-shaded.jar vscode-client/server/ansible-lsp-server.jar
cd vscode-client
npx vsce package

This produces a .vsix file in the vscode-client/ directory.

Contributing

Issues and feature requests are welcome. This project does not accept pull requests, commits, or other code contributions from third parties; the repository is maintained by the Qualimetry team only.

License

This extension is licensed under the Apache License, Version 2.0.

Qualimetry Ansible Analyzer

Qualimetry