Merge pull request #11 from ericclemmons/10-module-templates

Module Templates

Closes #10

.gitignore

@@ -1,3 +1,3 @@
-/node_modules
-/npm-debug.log
-/tmp
+node_modules
+npm-debug.log
+tmp

.jshintrc

@@ -0,0 +1,14 @@
+{
+  "curly": true,
+  "eqeqeq": true,
+  "immed": true,
+  "latedef": true,
+  "newcap": true,
+  "noarg": true,
+  "sub": true,
+  "undef": true,
+  "boss": true,
+  "eqnull": true,
+  "node": true,
+  "es5": true
+}

README.md

@@ -26,13 +26,13 @@ grunt.loadNpmTasks('grunt-angular-templates');
 This plugin provides the grunt task `ngtemplates`, which will allow you to compile your HTML templates into a single JS file,
 which preloads `$templateCache` to prevent round-trips to the server.
 
-### Update Grunt:
+### Update Grunt
 
 ```js
 // grunt.js
 grunt.initConfig({
   ngtemplates:  {
-    app:        {
+    myapp:      {
       options:  { base: 'src/views' },
       src:      [ 'src/views/**.html' ],
       dest:     'dist/templates.js'
@@ -41,19 +41,46 @@ grunt.initConfig({
 });
 ```
 
-### Add template module to your app
+**You should name your sub-target (e.g. `myapp`) after the name of the module the templates will be added to**.
+
+
+This will generate the following at `dist/templates.js`:
 
 ```js
-// js/app.js
-angular.module('app', [
-  'app.templates'  // Generated by ngtemplates:app
+angular.module('myapp').run(['$templateCache', function($templateCache) {
   ...
-]);
+}]);
+```
+
+### Include Compiled Templates
+
+This can either be done via HTML:
+
+```html
+<script src="dist/templates.js"></script>
+```
+
+or via your Gruntfile:
+
+```js
+concat: {
+  myapp: {
+    src: [
+      'src/js/**/*.js',       // MyApp module first
+      '<%= ngtemplates.myapp.dest %>' // Generated templates
+    ],
+    dest: 'dist/js/app.js'
+  }
+}
 ```
 
 
 ## Changelog
 
+### v0.3.0
+
+- **BC break** - Templates are added to an existing module (e.g. `myapp`) rather than being their own `myapp.templates` module to be manually included, thanks to @geddesign. ([#10](https://github.com/ericclemmons/grunt-angular-templates/issues/10))
+
 ### v0.2.2
 
 - Fixes

package.json

@@ -1,7 +1,7 @@
 {
   "name": "grunt-angular-templates",
   "description": "Grunt build task to concatenate & register your AngularJS templates in the $templateCache",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "homepage": "https://github.com/ericclemmons/grunt-angular-templates",
   "author": {
     "name": "Eric Clemmons",
@@ -22,16 +22,15 @@
   ],
   "main": "Gruntfile.js",
   "engines": {
-    "node": "0.8.x",
-    "npm": "1.1.x"
+    "node": ">= 0.8.0"
   },
   "scripts": {
     "test": "./node_modules/.bin/grunt"
   },
   "devDependencies": {
-    "grunt": "0.4.0rc7",
-    "grunt-contrib-jshint": "~0.1.0",
-    "grunt-contrib-nodeunit": "~0.1.1",
+    "grunt": "~0.4.0",
+    "grunt-contrib-jshint": "~0.1.1",
+    "grunt-contrib-nodeunit": "~0.1.2",
     "grunt-cli": "~0.1.6"
   },
   "keywords": [

tasks/angular-templates.js

@@ -15,7 +15,7 @@ module.exports = function(grunt) {
   var compiler = require('./lib/compiler').init(grunt);
 
   grunt.registerMultiTask('ngtemplates', 'Compile AngularJS templates', function() {
-    var id        = this.target + '.templates';
+    var id        = this.target;
     var base      = grunt.file.expand(this.options().base || '.')[0];
     var files     = grunt.file.expand(this.files[0].src);
     var dest      = path.normalize(this.files[0].dest);

tasks/lib/compiler.js

@@ -30,7 +30,7 @@ module.exports.init = function(grunt) {
   };
 
   var compile = function(id, base, files, callback) {
-    var template = 'angular.module("<%= id %>", []).run(["$templateCache", function($templateCache) {\n<%= content %>\n}]);\n';
+    var template = 'angular.module("<%= id %>").run(["$templateCache", function($templateCache) {\n<%= content %>\n}]);\n';
 
     concat(base, files, function(err, concated) {
       var options = {

test/expected/multiple.js

@@ -1,4 +1,4 @@
-angular.module("multiple.templates", []).run(["$templateCache", function($templateCache) {
+angular.module("multiple").run(["$templateCache", function($templateCache) {
 
   $templateCache.put("multiple/one.html",
     "<h1>One</h1>" +

test/expected/simple.js

@@ -1,4 +1,4 @@
-angular.module("simple.templates", []).run(["$templateCache", function($templateCache) {
+angular.module("simple").run(["$templateCache", function($templateCache) {
 
   $templateCache.put("simple.html",
     "Howdy there! \\ Your name is \"{{ name }}\"." +