Adonis Edge JS
VS Code helpers for AdonisJS routes and Edge templates.
Features
- Go to Controller from Route
- Formatter for Edge JS
- Go to File from
publicAsset / @vite / @include / @component
- Edge Spacer
1. Go to Controller from Route
Ctrl/Cmd+Click in route files to jump to controller files and methods.
Supported Files
**/routes/**/*.ts — route modules
**/routes/*.ts — flat routes folders
**/start/routes.ts — main routes file
Supported Click Targets
- Barrel controllers (AdonisJS generated) — click method or property
import { controllers } from '#generated/controllers'
router.get('/posts', [controllers.Posts, 'index'])
// Click 'index' → posts_controller.ts method index
// Click Posts → posts_controller.ts
- Lazy-imported controller variables
const AuthController = () => import('#controllers/dashboard/auth/auth_controller')
router.get('/login', [AuthController, 'login'])
// Click 'login' or AuthController → auth_controller.ts (method when clicking the string)
- Magic strings — click path or method inside one string
router.get('/', '#controllers/dashboard/auth/auth_controller.index')
// Click path → auth_controller.ts
// Click index → auth_controller.ts method index
#controllers/... import path strings
const UserController = () => import('#controllers/user_controller')
// Click '#controllers/user_controller'
Nested barrel keys are supported, e.g. [controllers.auth.Login, 'handle'] .
Built-in formatter for .edge templates — use Shift+Alt+F, Format Document, or format on save. Focuses on Edge directives and HTML structure (no syntax highlighting grammar in this package).
What it does
- Repair broken HTML tags split across lines (
</span + > → </span>)
- Put inline Edge directives on their own lines
- Join multi-line HTML attributes into one line, then wrap like blade-formatter (
wrapAttributes)
- Convert simple
@if / @else / @end plain-text branches to {{ cond ? 'a' : 'b' }}
- Optionally collapse short single-content HTML blocks (off by default so
<label> / form controls stay multiline)
- Indent nested
@component / @slot / @if / @each / HTML / <script> / <style>
Attribute wrap modes (same as shufo.vscode-blade-formatter): auto (default, pack to printWidth) | force | force-aligned | force-expand-multiline | aligned-multiple | preserve | preserve-aligned.
Example with auto + printWidth 140:
<input type="text" class="form-control regex-number" name="price" id="price" value="{{ FormatterHelper.formatNumber(product.price) }}"
onkeyup="formatNumberElement(this)" onpaste="formatNumberElement(this)" placeholder="Masukkan Harga" autocomplete="off">
Also
- Auto-align
@end / @endsection while typing
- Command / context menu: Edge: Convert HTML Comments to Edge Comments
- Optional convert HTML comments →
{{-- --}} on save
- Default indent / tab size: 4
// .vscode/settings.json
{
"[edge]": {
"editor.defaultFormatter": "codenameryuu.adonis-edge-js",
"editor.formatOnSave": true,
"editor.tabSize": 4,
"editor.links": false
},
"edge.format.indentSize": 4,
"edge.format.printWidth": 140,
"edge.format.wrapAttributes": "auto",
"edge.format.wrapAttributesMinAttrs": 2,
"edge.format.collapseShortBlocks": false,
"edge.format.convertHtmlCommentsOnSave": false
}
3. Go to File from publicAsset / @vite / @include / @component
In .edge files, editor.links is off by default so relative HTML href / src / action values (e.g. /logout, /assets/...) are not underlined.
Only these get link-style underlines:
publicAsset('...') / @vite('...') / @include('...') / @component('...') — Ctrl/Cmd+Click opens the file
- Absolute
http:// / https:// in HTML URL attrs — hover → Open URL
publicAsset
Register the Edge global helper in your app (e.g. a provider / Edge setup):
edge.global('publicAsset', (path: string) => {
const cleanPath = path.startsWith('/') ? path : `/${path}`
return cleanPath
})
Then use it in templates:
<img src="{{ publicAsset('assets/dashboard/custom/image/logo/logo.png') }}" width="80">
- Underlined; Ctrl/Cmd+Click opens
public/assets/dashboard/custom/image/logo/logo.png
- Leading
/ is optional
url
Register the Edge global helper (absolute URL from your app base URL):
edge.global("url", (path: string = "") => {
const baseUrl = appUrl.replace(/\/$/, "");
const cleanPath = path.replace(/^\/+/, "");
return cleanPath ? `${baseUrl}/${cleanPath}` : baseUrl;
});
Then use it in templates:
<img src="{{ url('assets/dashboard/custom/image/logo/logo.png') }}" width="80">
<a href="{{ url('dashboard') }}">Dashboard</a>
@vite
@vite('resources/views/dashboard/pages/product/create.js')
@vite(['resources/css/app.css', 'resources/js/app.js'])
- Each path string is underlined; Ctrl/Cmd+Click opens it from the project root
@include / @component
@include('dashboard/partials/sidebar')
@component('dashboard/layouts/main')
@!component('dashboard/layouts/main')
- Underlined; Ctrl/Cmd+Click opens
resources/views/<path>.edge (default disk)
- Disk prefix supported:
docs::guide/intro → disk docs from edge.disks
Absolute HTML URLs
<link href="https://fonts.googleapis.com/css2?family=Public+Sans&display=swap" rel="stylesheet">
- Underlined; hover → Open URL
- Relative attrs like
href="/dashboard", src="/assets/...", action="/logout" stay plain (no underline)
4. Edge Spacer
Typing Edge mustache tags auto-inserts inner spaces for easier editing:
{{}} → {{ | }} (escaped)
{{{}}} → {{{ | }}} (unescaped)
Only active in .edge files. Auto-close stays enabled ({{ → }}, {{{ → }}}).
How It Works
- Resolves within the project root (nearest
package.json)
- Routes: barrel / lazy import / magic string → controller via
package.json#imports
- Edge formatter: document / range / on-type formatting for
.edge files
- Edge:
editor.links off — relative HTML attrs are not follow-linked
- Edge: custom underlines for
publicAsset / @vite / @include / @component / absolute http(s)
- Edge: those helpers → Go to Definition; absolute
http(s) → hover Open URL
- Edge spacer: watches typing of
{{ }} / {{{ }}} and expands with spaces
Requirements
- VS Code 1.75.0 or later
- AdonisJS project with TypeScript (for route goto)
package.json#imports mapping for #controllers/*
- For barrel style: generated
.adonisjs/server/controllers.ts (or #generated/* import map)
Installation
- Install the extension
- Open an AdonisJS project
- Ctrl/Cmd+Click supported targets in routes or Edge files
- Format
.edge with Shift+Alt+F (or enable format on save)
Limitations
- Only
#controllers/* (and #generated/controllers for barrels) — not @controllers
publicAsset → public/; @vite → project root; @include / @component → edge.disks (default resources/views)
- Relative HTML
href / src / action are not navigable; only absolute http(s) URLs get hover Open URL
- This package does not include an Edge TextMate grammar — install a separate Edge highlighter if you want colors
- Simple
@if / @else plain-text branches may be rewritten to ternaries on format