Grails For VSCode

A suite for development with the Grails Framework in Visual Studio Code

Features

Commands for Grails Framework.
Grails project explorer

Grails project explorer

A Tree view with all the main entities of the Grais project, including

Views
Models
Controllers
Services
Tests
- Unit tests
- Integration tests
POM
- dependencies
- plugins

A sample Grails Tree Data Provider can be found in the src folder.

extension.ts

import * as vscode from "vscode";
import { SampleTreeProvider } from "./sampleTree";

export function activate(context: vscode.ExtensionContext) {
  const treeDataProvider = new GrailsTreeProvider();
  context.subscriptions.push(
    vscode.window.registerTreeDataProvider("grailsTreeView", treeDataProvider)
  );
}

package.json

"contributes": {
    "views": {
        "explorer": [
            {
                "id": "grailsTreeView",
                "name": "Grails Tree",
                "when": "resourceFilename =~ /test/"
            }
        ]
    }
}

Commands

Activate commands with CTRL+P on Windows/Linux or Cmd+P on Mac.

App

Run App

grails run-app

$ ./grailsw run-app --port=8090

Stop App
Run Command

Builders

Create App

grails create-app GrailsEnterpriseApplication

Create Plugin

grails create-plugin GrailsEnterpriseDomain

Create Domain Class

grails create-domain-class Student grails create-domain-class org.ast.User

Create Controller

grails create-controller Student

Create Service
Create Filter
Create Interceptor (Grails 3+)
Create Hibernate Configuration File XML
Create Script
Create Taglib
Create Unit Test
Create Integration Test
Create POM XML

grails create-pom org.mycompany

Generators

Generate WAR
Generate Views

├── show.gsp
├── index.gsp
├── create.gsp
└── edit.gsp

Generate Controllers
Generate All (Views and Controllers)

grails generate-all Student

Test
``

Misc

Grails Dependency Report
Grails Help
List Plugins
Console
Stats
Package Plugin

grails package-plugin

Execute command on the GrailsEnterpriseDomain project. This command create a zip archive of your plugin but more importantely a plugin.xml file which later on is used by the main application on bootstrap, for loading and resolving possible dependencies of our domain plugin. So if our domain plugin would depend on other plugins, Grails would resolve those dependencies on application startup.

Maven Install

Project

Clean Project
Compile Project

Proxy

Add Proxy Configuration
Add Proxy Configuration (With User & Password)
Clear Proxy Configuration
Remove Proxy Configuration
Set Proxy Configuration

Documentation

Generate Documentation
Migrate Docs

TODO

List profile

grails list-profiles

You can optionally specify a Profile for your Grails app. Profiles are available for many common application types, including rest-api, angular, react, and others, and you can even create your own.

To use a profile, specify its name preceded by the -profile flag:

grails create-app myApp -profile rest-api

To get detailed information about a profile use the profile-info command.

$ grails profile-info plugin

Requirements

Have Grails Framework installed and configured.
Have Java Development Kit installed and configured
The GRAILS_HOME environment variable set with the Grails installation path
The JAVA_HOME environment variable set with the Java Development Kit (aka JDK) installation path

Development

Currently the plugin only registers a number of commands.

These commands can be registered to be triggered from various places in the IDE, such as from the command palette via contributes.menus.commandPalette in package.json.

  "contributes": {
    "menus": {
      "commandPalette": [
        {
          "command": "myExtension.sayHello",
          "when": "editorLangId == markdown"
        }
      ]
    },

The command can be made available only when a certain condition is met via when clauses

Examples include:

resourceDirname == 'controllers'
editorLangId == 'groovy'
resourceExtname == '.gsp' when selecting a groovy file
resourceFilename == 'POM.xml'

See the full set of context keys

Example of

{ "key": "ctrl+shift+t",  "command": "gfvscode.runTest",
                   "when": "resourceExtname == *.test.gsp" },
                   ```

If you wanted to add a context menu command to folders that contain a certain type of file (or something that can't be statically known), you can now use the in operator to achieve it.

vscode.commands.executeCommand("setContext", "ext.supportedFolders", [
  "controllers",
]);

Then, in the package.json you could add a menu contribution for the explorer/context menu:

// Note, this assumes you have already defined a command called ext.doSpecial
"menus": {
  "explorer/context": [
    {
      "command": "gfvscode.generateViewForController",
      "when": "explorerResourceIsFolder && resourceFilename in ext.supportedFolders"
    }
  ]
}

Command activation

Currently the activationEvents entry in the package.json is empty

"activationEvents": [],

See Activation events

onLanguage

This activation event is emitted and interested extensions will be activated whenever a file that resolves to a certain language gets opened.

"activationEvents": [
    "onLanguage:python"
]

workspaceContains

This activation event is emitted and interested extensions will be activated whenever a folder is opened and the folder contains at least one file that matches a glob pattern.

"activationEvents": [
    "workspaceContains:**/.editorconfig"
]

kristianmandrup/gfvscode