Create package.json and jshint config only if they do not exist

corburn · corburn · commit eb344e2a878e · 2014-04-05T02:41:49.000-07:00
Update grunt module functions to file-utils module functions
Fix package.json empty name property
diff --git a/app/index.js b/app/index.js
@@ -1,21 +1,48 @@
 'use strict';
-var grunt = require('grunt');
 var yeoman = require('yeoman-generator');
 
 var GruntfileGenerator = yeoman.generators.Base.extend({
   initializing: function () {
     this.pkg = require('../package.json');
+
+    // Check if package.json or jshint config exist
+    // to determine if they should be created later
+    if (this.dest.exists('package.json')) {
+      this.packageJSON = this.dest.readJSON('package.json');
+      this.appname = this.packageJSON.name || this.appname;
+      this.hasJshint = this.packageJSON.hasOwnProperty('jshintConfig') || this.dest.exists('.jshintrc');
+    } else {
+      this.hasJshint = this.dest.exists('.jshintrc');
+    }
+
+    function prefer(arr, preferred) {
+      for (var i = 0; i < preferred.length; ++i) {
+        if (arr.indexOf(preferred[i]) !== -1) {
+          return preferred[i];
+        }
+      }
+      return preferred[0];
+    }
+
+    var dirs = this.dest.expand({ filter: 'isDirectory' }, '*').map(function (d) {
+      return d.slice(0, -1);
+    });
+
+    this.jquery = this.dest.expand({ filter: 'isFile' }, '**/jquery*.js').length > 0;
+    this.libDir = prefer(dirs, ['lib', 'src']);
+    this.testDir = prefer(dirs, ['test', 'tests', 'unit', 'spec']);
   },
 
   prompting: function () {
     var done = this.async();
 
-    this.log(this.yeoman);
-    this.log('This template tries to guess file and directory paths, but ' +
-                'you will most likely need to edit the generated Gruntfile.js file before ' +
-                'running grunt. _If you run grunt after generating the Gruntfile, and ' +
-                'it exits with errors, edit the file!_');
-
+    if (!this.options['skip-install-message']) {
+      this.log(this.yeoman);
+      this.log('This template tries to guess file and directory paths, but ' +
+               'you will most likely need to edit the generated Gruntfile.js file before ' +
+               'running grunt. _If you run grunt after generating the Gruntfile, and ' +
+               'it exits with errors, edit the file!_');
+    }
 
     var prompts = [{
       type: 'checkbox',
@@ -24,47 +51,22 @@ var GruntfileGenerator = yeoman.generators.Base.extend({
       choices: [{
         name: 'Is the DOM involved in ANY way?',
         value: 'dom',
-        checked: false
+        checked: true
       }, {
         name: 'Will files be concatenated or minified?',
         value: 'minConcat',
-        checked: false
-      }, {
-        name: 'Will you use a package.json file?',
-        value: 'packageJSON',
-        checked: false
+        checked: true
       }]
     }];
 
-    function prefer(arr, preferred) {
-      for (var i = 0; i < preferred.length; ++i) {
-        if (arr.indexOf(preferred[i]) !== -1) {
-          return preferred[i];
-        }
-      }
-      return preferred[0];
-    }
-
-    var dirs = grunt.file.expand({ filter: 'isDirectory' }, '*').map(function (d) {
-      return d.slice(0, -1);
-    });
-
-    this.jquery = grunt.file.expand({ filter: 'isFile' }, '**/jquery*.js').length > 0;
-    this.libDir = prefer(dirs, ['lib', 'src']);
-    this.testDir = prefer(dirs, ['test', 'tests', 'unit', 'spec']);
-
     this.prompt(prompts, function (answers) {
-      var features = answers.features;
-
       function hasFeature(feat) {
-        return features.indexOf(feat) !== -1;
+        return answers.features.indexOf(feat) !== -1;
       }
 
       this.dom = hasFeature('dom');
       this.minConcat = hasFeature('minConcat');
-      this.packageJSON = hasFeature('packageJSON');
       this.testTask = hasFeature('dom') ? 'qunit' : 'nodeunit';
-      this.fileName = hasFeature('packageJSON') ? '<%= pkg.name %>' : 'FILE_NAME';
 
       done();
     }.bind(this));
@@ -76,9 +78,15 @@ var GruntfileGenerator = yeoman.generators.Base.extend({
 
   writing: function () {
     if (!this.packageJSON) {
-      this.template('package.json');
+      this.template('_package.json', 'package.json');
+    }
+    this.template('_Gruntfile.js', 'Gruntfile.js');
+  },
+
+  install: function () {
+    if (!this.options['skip-install']) {
+      this.installDependencies();
     }
-    this.template('gruntfile.js');
   }
 });
 
diff --git a/app/templates/_Gruntfile.js b/app/templates/_Gruntfile.js
@@ -1,31 +1,23 @@
 module.exports = function (grunt) {
-	'use strict';
+    'use strict';
     // Project configuration
-    grunt.initConfig({<% if (minConcat) { %>
-        // Metadata<% if (packageJSON) { %>
+    grunt.initConfig({
+        // Metadata
         pkg: grunt.file.readJSON('package.json'),
         banner: '/*! <%%= pkg.name %> - v<%%= pkg.version %> - ' +
             '<%%= grunt.template.today("yyyy-mm-dd") %>\n' +
             '<%%= pkg.homepage ? "* " + pkg.homepage + "\\n" : "" %>' +
             '* Copyright (c) <%%= grunt.template.today("yyyy") %> <%%= pkg.author.name %>;' +
-            ' Licensed <%%= props.license %> */\n',<% } else { %>
-        meta: {
-            version: '0.1.0'
-        },
-        banner: '/*! PROJECT_NAME - v<%%= meta.version %> - ' +
-            '<%%= grunt.template.today("yyyy-mm-dd") %>\n' +
-            '* http://PROJECT_WEBSITE/\n' +
-            '* Copyright (c) <%%= grunt.template.today("yyyy") %> ' +
-            'YOUR_NAME; Licensed MIT */\n',<% } } %>
+            ' Licensed <%%= props.license %> */\n',
         // Task configuration<% if (minConcat) { %>
         concat: {
             options: {
                 banner: '<%%= banner %>',
                 stripBanners: true
             },
             dist: {
-                src: ['<%= libDir %>/<%= fileName %>.js'],
-                dest: 'dist/<%= fileName %>.js'
+                src: ['<%= libDir %>/<%= appname %>.js'],
+                dest: 'dist/<%= appname %>.js'
             }
         },
         uglify: {
@@ -34,9 +26,9 @@ module.exports = function (grunt) {
             },
             dist: {
                 src: '<%%= concat.dist.dest %>',
-                dest: 'dist/<%= fileName %>.min.js'
+                dest: 'dist/<%= appname %>.min.js'
             }
-        },<% } %>
+        },<% } %><% if (!hasJshint) {%>
         jshint: {
             options: {
                 node: true,
@@ -49,13 +41,11 @@ module.exports = function (grunt) {
                 sub: true,
                 undef: true,
                 unused: true,
-                boss: true,
                 eqnull: true,<% if (dom) { %>
-                browser: true,<% } %>
-                globals: {<% if (jquery) { %>
-                    jQuery: true
-                <% } %>}
-            },
+                browser: true,<% } %><% if (jquery || testTask === 'qunit') { %>
+                globals: { jQuery: true },<% } %>
+                boss: true
+            },<% } %>
             gruntfile: {
                 src: 'gruntfile.js'
             },
@@ -90,4 +80,5 @@ module.exports = function (grunt) {
 
     // Default task
     grunt.registerTask('default', ['jshint', '<%= testTask %>'<%= minConcat ? ", 'concat', 'uglify'" : "" %>]);
-};
+};
+
diff --git a/app/templates/_package.json b/app/templates/_package.json
@@ -1,5 +1,5 @@
 {
-  "name": "",
+  "name": "<%= _.slugify(appname) %>",
   "version": "0.0.0",
   "dependencies": {},
   "devDependencies": {
@@ -8,6 +8,6 @@
     "grunt-contrib-concat": "~0.3.0",
     "grunt-contrib-uglify": "~0.2.7",<% } %>
     "grunt-contrib-jshint": "~0.7.2",
-    "grunt-contrib-<%= testTask %>": ""
+    "grunt-contrib-<%= testTask %>": "*"
   }
 }
diff --git a/test/test.js b/test/test.js
@@ -1,22 +1,27 @@
 /*global beforeEach, describe, it */
 'use strict';
 
+var file = require('yeoman-generator').file;
 var helpers = require('yeoman-generator').test;
 var path = require('path');
 
-describe('gruntfile:app', function () {
+describe('gruntfile:app empty project', function () {
   var generator;
 
-  beforeEach(function (cb) {
-    helpers.testDirectory(path.join(__dirname, 'temp'), function () {
-      var deps = ['../../app'];
-      generator = helpers.createGenerator('gruntfile:app', deps);
-      cb();
+  beforeEach(function (done) {
+    helpers.testDirectory(path.join(__dirname, 'temp'), function (err) {
+      if (err) {
+        done(err);
+      }
+      generator = helpers.createGenerator('gruntfile:app', ['../../app']);
+      generator.options['skip-install'] = true;
+      generator.options['skip-install-message'] = true;
+      done();
     });
   });
 
-  it('creates expected files', function (cb) {
-    var expected = ['gruntfile.js'];
+  it('creates expected files', function (done) {
+    var expected = ['Gruntfile.js', 'package.json'];
 
     helpers.mockPrompt(generator, {
       features: [
@@ -27,7 +32,69 @@ describe('gruntfile:app', function () {
 
     generator.run({}, function () {
       helpers.assertFile(expected);
-      cb();
+      done();
     });
   });
 });
+
+describe('gruntfile:app with existing package.json', function () {
+  var generator;
+
+  beforeEach(function (done) {
+    helpers.testDirectory(path.join(__dirname, 'temp'), function (err) {
+      if (err) {
+        done(err);
+      }
+      file.write('package.json', '{"jshintConfig":{}}');
+      generator = helpers.createGenerator('gruntfile:app', ['../../app']);
+      generator.options['skip-install-message'] = true;
+      generator.options['skip-install'] = true;
+      done();
+    });
+  });
+
+  it('creates expected files', function (done) {
+    var expected = ['Gruntfile.js', 'package.json'];
+
+    helpers.mockPrompt(generator, {
+      features: [
+        'dom',
+        'minConcat'
+      ]
+    });
+
+    generator.run({}, function () {
+      helpers.assertFile(expected);
+      done();
+    });
+  });
+
+  it('does not replace existing package.json', function (done) {
+    helpers.mockPrompt(generator, {
+      features: [
+        'dom',
+        'minConcat'
+      ]
+    });
+
+    generator.run({}, function () {
+      helpers.assertFileContent('./package.json', /jshintConfig/);
+      done();
+    });
+  });
+
+  it('does not conflict with jshintConfig property', function (done) {
+    helpers.mockPrompt(generator, {
+      features: [
+        'dom',
+        'minConcat'
+      ]
+    });
+
+    generator.run({}, function () {
+      helpers.assertNoFileContent('./Gruntfile.js', /jshint: {/);
+      done();
+    });
+  });
+});
+

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "name": "",`
	`2`	`+ "name": "<%= _.slugify(appname) %>",`
`3`	`3`	`"version": "0.0.0",`
`4`	`4`	`"dependencies": {},`
`5`	`5`	`"devDependencies": {`
`@@ -8,6 +8,6 @@`
`8`	`8`	`"grunt-contrib-concat": "~0.3.0",`
`9`	`9`	`"grunt-contrib-uglify": "~0.2.7",<% } %>`
`10`	`10`	`"grunt-contrib-jshint": "~0.7.2",`
`11`		`- "grunt-contrib-<%= testTask %>": ""`
	`11`	`+ "grunt-contrib-<%= testTask %>": "*"`
`12`	`12`	`}`
`13`	`13`	`}`