Statamic Toolkit

A PhpStorm plugin providing rich editor support for the Antlers template language used by Statamic CMS.

Features

• Syntax Highlighting for .antlers.html and .antlers.php files
  • Variables, tags, modifiers, operators, keywords
  • String and number literals
  • Comments ({{# #}})
  • PHP regions ({{? ?}}, {{$ $}})
  • Semantic colors for tag names, parameter names, and more
• HTML, CSS, and JavaScript Intelligence -- full template-aware editor support inside Antlers files via IntelliJ's Template Language framework
• Official Statamic Completion -- tags, modifiers, variables, common tag parameters, and scope-aware loop variables backed by the official Statamic docs
• Hover Documentation -- quick docs with examples and links to statamic.dev for tags, modifiers, and variables
• PHP Intelligence -- full PHP support inside {{? ?}} and {{$ $}} blocks with highlighting, completion, and formatting from your PhpStorm settings
• Alpine.js Support -- JavaScript intelligence inside Alpine attributes (x-data, @click, x-bind, x-transition, etc.) with method navigation back to x-data
• Antlers Language Server -- integrated Stillat LSP for formatting and diagnostics, bundled with the plugin
• Partial Navigation -- Cmd-click on partial:name to jump to the partial file
• Tag Parameter Completion -- suggests official parameters (from=, limit=, sort=, etc.) for common Statamic tags
• Scope-Aware Variables -- suggests title, slug, url, first, last, count, etc. inside collection/nav/taxonomy loops
• Collection Handle Completion -- {{ collection: }} suggests handles from flat-file or Eloquent driver (queries database via artisan)
• Go-To Custom Tags/Modifiers -- Cmd-click navigates to PHP classes in app/Tags/ and app/Modifiers/
• Extract to Partial -- select code, Alt+Enter to extract into a new partial file
• Structure View -- Antlers tags + HTML landmarks (<header>, <main>, <section>, etc.) in document order with nested tag pair children
• Formatting -- template-aware formatting with mixed Antlers/HTML indentation, control-flow alignment, and block tag indentation for collection, nav, cache, foreach, entries, groups, items, and more
• Auto-Close Tags -- typing {{ / auto-completes the closing tag name; Enter after block tags auto-indents
• Brace Matching -- highlights matching {{ }} pairs
• Block Commenting -- toggle comments with {{# #}} via Ctrl+/ (Cmd+/)
• Typing Aids -- auto-closing braces, smart quotes, and smart enter handling
• Status Bar Widget -- shows Statamic indexing status, driver detection, resource counts, Antlers LSP connection state, quick links, refresh, and auto-index toggle
• Statamic Menu -- top-level menu with content query snippets plus controller, tag, and modifier generators
• Storage Driver Conversion -- switch between flat-file and Eloquent storage from the Data Source settings page with preflight validation, progress reporting, backups, verification, and rollback
• Customizable Colors -- Settings > Editor > Color Scheme > Antlers, with separate keys for tag heads, partial paths, delimiters, modifiers, and parameters

Supported Syntax

Construct	Example
Variables	{{ title }}, {{ post:title }}
Tags	{{ collection:blog limit="5" }}...{{ /collection:blog }}
Modifiers	{{ title | upper | truncate(50) }}
Conditionals	{{ if }}, {{ elseif }}, {{ else }}, {{ unless }}
Operators	==, !=, &&, ||, ??, ?:, +, -, *, /
Assignment	{{ total = price * quantity }}
Comments	{{# This is a comment #}}
PHP	{{? $var = doSomething(); ?}}, {{$ route('home') $}}
Self-closing	{{ partial:hero /}}
Escaped	@{{ not_parsed }}

Installation

From JetBrains Marketplace

Coming soon

From Source

git clone https://github.com/portseif/statamic-toolkit-phpstorm.git
cd statamic-toolkit-phpstorm
./gradlew runIde

This launches a sandboxed IDE instance with the plugin installed.

Requirements

• PhpStorm 2024.2+
• JDK 21
• Node.js available on your machine for the bundled Antlers Language Server

Building

./gradlew build          # Build the plugin
./gradlew test           # Run tests
./gradlew runIde         # Launch sandbox IDE
./gradlew buildPlugin    # Package as .zip for distribution

Storage Driver Conversion

The Settings > Languages & Frameworks > Statamic > Data Source page can switch a project between flat-file and Eloquent storage.

• The page detects the active driver, storage location, storage size, and tracked record count before conversion.
• Every conversion runs a preflight pass that checks PHP/artisan/please availability, writable project files, disk headroom, database connectivity, migration readiness, and target-side conflicts.
• The conversion workflow creates backups before changing state, shows phase-based progress, verifies the migrated data, rewrites the active driver only after verification, and rolls back automatically if a step fails.
• Detailed logs are written to storage/logs/statamic-storage-conversion-*.log, and recovery backups are stored under storage/statamic-toolkit/backups/.

Known limitations:

• The project still needs working php, artisan, and please commands in the local environment.
• Database backup and rollback use a JSON snapshot of Statamic tables rather than engine-specific dump tools.
• Projects using map_data_to_columns=true may need a manual review of custom entry models after conversion.

See STORAGE_DRIVER_CONVERSION.md for the full conversion sequence, conflict handling behavior, and rollback details.

Roadmap

• Syntax highlighting
• Brace matching
• Block commenting
• HTML/CSS/JS intelligence in template files
• Code completion for Statamic tags and modifiers
• Go-to-definition for partials
• Formatting support
• Structure view
• Alpine.js support
• PHP intelligence in PHP blocks
• Hover documentation
• Statamic generators (controllers, tags, modifiers)
• Configurable settings panel
• Code folding for tag pairs
• Tag parameter completion
• Scope-aware variable completion
• Go-to custom tag/modifier definition
• Extract to partial refactoring
• Antlers Language Server integration
• Eloquent driver support
• Status bar indexing widget
• Live templates / snippets
• Blueprint field completion

Disclaimer

This plugin is not affiliated with, endorsed by, or officially connected to Statamic. "Statamic" and the Statamic logo are trademarks of Statamic. However, Jack McDade did give me permission to use the name "Statamic Toolkit."

License

MIT