AQL Formatter

A Visual Studio Code extension that provides formatting and syntax highlighting for ArangoDB Query Language (AQL).

Features

Formatting

Trigger with Shift+Alt+F (or your configured format shortcut) on any .aql file.

• Puts each clause keyword on its own line (FOR, FILTER, LET, SORT, LIMIT, COLLECT, RETURN, INSERT, UPDATE, REPLACE, REMOVE, UPSERT, SEARCH, WINDOW, etc.)
• Auto-indents FOR loop bodies, including nested loops
• Handles subqueries in parentheses with proper scope and indentation
• Breaks long arrays and objects into multiline format when they exceed the configured print width
• Normalizes keywords to UPPERCASE
• Preserves comments and string literals
• Cleans up extraneous whitespace

Before:

FOR doc IN collection FILTER doc.active == true SORT doc.name ASC LIMIT 10 RETURN { name: doc.name, email: doc.email }

After:

FOR doc IN collection
  FILTER doc.active == TRUE
  SORT doc.name ASC
  LIMIT 10
  RETURN { name: doc.name, email: doc.email }

Syntax Highlighting

• Clause keywords and operator keywords
• String literals (single, double, and backtick quoted)
• Numeric literals (integer, float, hex)
• Line and block comments
• Boolean and null constants
• Bind parameters (@param, @@collection)
• Function calls
• Operators

Language Support

• Bracket matching and auto-closing
• Comment toggling (Ctrl+/)

Configuration

Installation

From VSIX (local)

cd aql-formatter
npm install
npx @vscode/vsce package
code --install-extension aql-formatter-0.1.0.vsix

From Source (development)

1. Open the aql-formatter folder in VS Code
2. Run npm install
3. Press F5 to launch the Extension Development Host
4. Open any .aql file and format it with Shift+Alt+F

Supported AQL Constructs

Development

npm install          # install dependencies
npm run compile      # compile TypeScript
npm run watch        # compile + watch for changes
npm test             # run tests
npm run lint         # run ESLint

License

This project is licensed under the GNU General Public License v3.0.