0

I'm writing my first Grails (2.3.6) app and need to use the following libraries:

I would like to configure these libraries from inside a web-app/js/application.js file. I'm not sure if I should:

  • Manually add the libraries to my web-app/js/ directory, and then import them as <script> elements from inside my GSP (see below); or
  • Pull them in from BuildConfig.groovy.

With the former approach:

// Inside index.gsp:
<body>
    <script type="text/javascript" src="${resource(dir: 'js', file: 'signals.min.js')}" />
    <script type="text/javascript" src="${resource(dir: 'js', file: 'crossroads.min.js')}" />
    <script type="text/javascript" src="${resource(dir: 'js', file: 'hasher.min.js')}" />
    <script type="text/javascript" src="${resource(dir: 'js', file: 'application.js')}" />
</body>

With the latter approach:

// Inside BuildConfig.groovy:
plugins {
    runtime: ":signals:???"
    runtime: ":crossroads:???"
    runtime: ":hasher:???"
}

Which way is the right way to go with Grails, and why? And, if the latter approach is the generally-accepted method, what values do I need for each runtime entry?

IAmYourFaja
  • 55,468
  • 181
  • 466
  • 756
  • 2
    You are using resources plugin which comes with a grails app by default (until 2.3.9, with 2.4.0 default plugin for resource management is asset-pipeline). [`resources` plugin](http://grails.org/plugin/resources) comes with set of guidelines to efficiently manage resources. Refer [declaring resources](http://grails-plugins.github.io/grails-resources/guide/3.%20Declaring%20resources.html) doc for more details. – dmahapatro May 22 '14 at 17:52
  • Thanks @dmahapatro (+1) - so it looks like I need to declare a "module" that includes all 3 JS libs (Signals, Crossroads and Hasher), yes? If so, let's say I create a `routing` module that contains 3 resources for all 3 libs; how do I include this `routing` module in a GSP so that its available when the page loads? – IAmYourFaja May 22 '14 at 19:12
  • 1
    Yes. Turn to the [next page to see "using resources"](http://grails-plugins.github.io/grails-resources/guide/4.%20Using%20resources.html) in the docs. :) – dmahapatro May 22 '14 at 19:25

2 Answers2

1

Personally I would only go the plugin route if you think these libraries would be a good fit for the community and you want to maintain them. It seems you should either be using the resource plugin as mentioned or the asset-pipeline plugin.

Personally I would definitely go with the asset pipeline plugin instead of resources. It will be the default in 2.4 and IMHO way easier and faster to use. Lots of other plugins already integrate with it, and it is dead simple to use. You can also add the full non minified versions of the libraries so you have access to them in development for debugging and when you war your project up the plugin will automatically minify and bundle them for you.

1) Add your libraries to /assets/js/. 2) Add this to application.js

//This is a javascript file with its top level require directives
//= require signals.js
//= require crossroads.js
//= require hasher.js
//= require_self

console.log("This is my javascript manifest");

3) Add the asset to your page or layout

<head>
    <asset:javascript src="application.js"/>
</head>

http://grails.org/plugin/asset-pipeline

bbooth
  • 26
  • 4
0

Without asset pipeline in Grails 2, and as a work-around for asset pipeline issues, such as CKEditor, I had to do: <g:javascript src="ckeditor/ckeditor"></g> in my appLayout, and add the library to web-app/js. (Apparently, CKE has problems with Asset Pipeline).

Here is the documentation(Grails v.2.3.7): https://grails.github.io/grails2-doc/2.3.7/ref/Tags/javascript.html

I also found this link very helpful: Where should I put javascript libraries in a Grails app?

Jeff Brewster
  • 161
  • 1
  • 3