lots of refactoring

Author: daniellmb

.jshintrc

@@ -1,5 +1,6 @@
 {
   "node": true,
+  "browser": true,
   "esnext": true,
   "bitwise": true,
   "camelcase": true,
@@ -18,6 +19,7 @@
   "trailing": true,
   "smarttabs": true,
   "white": true,
+  "validthis": true,
   "globals": {
     "chai": false,
     "sinon": false,
@@ -35,6 +37,7 @@
     "expect": false,
     "spyOn": false,
     "xdescribe": false,
-    "xit": false
+    "xit": false,
+    "define": false
   }
 }

README.md

@@ -23,6 +23,7 @@ Quickly scaffold out a micro library or framework.
     * [Mocha](http://visionmedia.github.io/mocha)
     * [QUnit](http://qunitjs.com) (TODO)
   * Test coverage pre-configured to publish to code climate.
+  * Micro library template is pre-configured for AMD, Node.js and browser support.
   * README file
     * Dynamic based on the project configurations.
     * Pre-configured badges for:
@@ -61,7 +62,7 @@ To install generator-microjs from npm, run:
 $ npm install -g generator-microjs
 ```
 
-## Use
+## Scaffolding
 
 Go to your new project folder, run the generator and follow the prompts. The use `--coffee` flag is optional.
 
@@ -71,10 +72,6 @@ $ yo microjs --coffee
 
 Check the generated `.travis.yml` file you'll need to fill in some data if you want to publish build status and test coverage reports.
 
-```bash
-$ yo microjs --coffee
-```
-
 Write unit tests and add code to create you micro-framework or library. Run your tests using:
 
 ```bash

app/index.js

@@ -34,6 +34,12 @@ var extractProj = function (_, appname) {
   return slugged;
 };
 
+var toCamelCase = function (input) {
+  return input.toLowerCase().replace(/-(.)/g, function (match, group1) {
+    return group1.toUpperCase();
+  });
+};
+
 var githubUserInfo = function (name, cb) {
 
   // handle bad data
@@ -132,6 +138,7 @@ var MicroJSGenerator = yeoman.generators.Base.extend({
 
       this.projName = props.projName;
       this.baseFileName = path.basename(this.projName, path.extname(this.projName));
+      this.exportName = toCamelCase(this.baseFileName);
 
       done();
     }.bind(this));
@@ -236,14 +243,14 @@ var MicroJSGenerator = yeoman.generators.Base.extend({
   projectFiles: function () {
     this.copy('editorconfig', '.editorconfig');
     this.copy('npmignore', '.npmignore');
+    this.template('umd', '.umd');
 
     // only copy over coffee if the option was set
     if (this.options.coffee) {
       this.template('micro-tmpl.coffee', this.baseFileName + '.coffee');
     }
     this.template('micro-tmpl.js', this.baseFileName + '.js');
     this.template('micro-tmpl.min.js', this.baseFileName + '.min.js');
-    this.template('micro-tmpl.min.js', this.baseFileName + '.min.js.map');
     this.template('README.md', 'README.md');
   },
 

app/templates/README.md

@@ -11,7 +11,7 @@
 
 ## About
 
-All about how amazing your <%= projName %> micro-library is.
+All about how amazing the <%= projName %> micro-library is.
 
 ## Examples
 
@@ -27,9 +27,15 @@ All about how amazing your <%= projName %> micro-library is.
 - `bower install <%= projName %>`
 - [download the zip](https://github.com/<%= githubUser %>/<%= projName %>/archive/master.zip)
 
-## Testing
+## Tasks
 
-Tests can be run with the `npm test` command.
+All tasks can be run by simply running `<%= taskFramework %>` or with the `npm test` command, or individually:
+
+  * `<%= taskFramework %> lint` will lint source code for syntax errors and anti-patterns.
+  * `<%= taskFramework %> gpa` will analyze source code against complexity thresholds.
+  * `<%= taskFramework %> test` will run the <%= testFramework %> unit tests against the source code.<% if (options.coffee) { %>
+  * `<%= taskFramework %> test-coffee` will run the <%= testFramework %> unit tests against the CoffeeScript source code.<% } %>
+  * `<%= taskFramework %> test-min` will run the <%= testFramework %> unit tests against the minified code.
 
 ## License
 

app/templates/_gruntfile.js

@@ -4,7 +4,7 @@
  * ### Responsibilities
  * - automate common tasks using grunt
  *
- * Generated on <%= (new Date).toISOString().split('T')[0] %> using <%= pkg.name %> v<%= pkg.version %>
+ * Scaffolded with <%= pkg.name %> v<%= pkg.version %>
  *
  * @author <%= realname %> <<%= email %>>
  */

app/templates/_gulpfile.js

@@ -4,7 +4,7 @@
  * ### Responsibilities
  * - automate common tasks using gulp
  *
- * Generated on <%= (new Date).toISOString().split('T')[0] %> using <%= pkg.name %> v<%= pkg.version %>
+ * Scaffolded with <%= pkg.name %> v<%= pkg.version %>
  *
  * @author <%= realname %> <<%= email %>>
  */
@@ -15,20 +15,24 @@ var gulp = require('gulp'),
     complexity = require('gulp-complexity'),
     uglify = require('gulp-uglify'),
     rename = require('gulp-rename'),
+    replace = require('gulp-replace'),
     karma = require('gulp-karma'),
+    fs = require('fs'),
     source = '<%= baseFileName %>.js',
     sourceMin = '<%= baseFileName %>.min.js',
-    sourceAndSpecs = [source, 'test/spec/*.spec.js'];
+    specs = 'test/spec/*.spec.js',
+    karmaConf = 'test/karma.conf',
+    umdWrapper = fs.readFileSync('./.umd');
 
 gulp.task('lint', function () {
-  return gulp.src(sourceAndSpecs)
+  return gulp.src([source, specs])
     .pipe(jshint())
     .pipe(jshint.reporter('default'))
     .pipe(jshint.reporter('fail'));
 });
 
 gulp.task('gpa', function () {
-  return gulp.src(sourceAndSpecs)
+  return gulp.src([source, specs])
     .pipe(complexity({
       cyclomatic: [8],
       halstead: [9],
@@ -37,27 +41,35 @@ gulp.task('gpa', function () {
 });
 
 gulp.task('test', function () {
-  return gulp.src(sourceAndSpecs)
+  return gulp.src([source, specs])
     .pipe(karma({
-      configFile: 'test/karma.conf.js'
+      configFile: karmaConf + '.js'
     }));
 });
-<% if (options.coffee) { %>
-gulp.task('test-coffee', function () {
-  return gulp.src(['<%= baseFileName %>.coffee', 'test/spec/*.spec.coffee'])
-    .pipe(karma({
-      configFile: 'test/karma.conf.coffee'
-    }));
-});<% } %>
 
 gulp.task('min', function () {
   return gulp.src(source)
     .pipe(rename(sourceMin))
     .pipe(uglify({
-      preserveComments: 'some',
       outSourceMap: true
     }))
+    .pipe(replace(/(.*)/, umdWrapper))
     .pipe(gulp.dest('.'));
 });
+<% if (options.coffee) { %>
+gulp.task('test-coffee', function () {
+  return gulp.src(['<%= baseFileName %>.coffee', 'test/spec/*.spec.coffee'])
+    .pipe(karma({
+      configFile: karmaConf + '.coffee'
+    }));
+});<% } %>
+
+gulp.task('test-min', ['min'], function () {
+  return gulp.src([sourceMin, specs])
+    .pipe(karma({
+      configFile: karmaConf + '.js',
+      reporters: ['dots']
+    }));
+});
 
-gulp.task('default', ['lint', 'gpa', 'test',<% if (options.coffee) { %> 'test-coffee',<% } %> 'min']);
+gulp.task('default', ['lint', 'gpa', 'test',<% if (options.coffee) { %> 'test-coffee',<% } %> 'test-min']);

app/templates/_package.json

@@ -43,6 +43,7 @@
     "gulp-jshint": "*",
     "gulp-complexity": "*",
     "gulp-rename": "*",
+    "gulp-replace": "*",
     "gulp-uglify": "*",<% if (options.coffee) { %>
     "gulp-coffee": "*",<% } %>
     "gulp-karma": "*",<% } %><% if (taskFramework === 'grunt') { %>

app/templates/jshintrc

@@ -14,17 +14,19 @@
   "quotmark": "single",
   "regexp": true,
   "undef": true,
-  "unused": false,
-  "strict": true,
+  "strict": false,
   "trailing": true,
   "smarttabs": true,
+  "validthis": true,
   "white": true,
-  "globals": {<% if (testFramework === 'mocha') { %>
+  "globals":{<% if (testFramework === 'mocha') { %>
     "chai": false,
     "sinon": false,
     "assert": false,
     "describe": false,
+    "xdescribe": false,
     "it": false,
+    "xit": false,
     "before": false,
     "after": false,
     "beforeEach": false,
@@ -33,14 +35,15 @@
     "test": false,
     "setup": false,
     "teardown": false,
-    "expect": false<% } %><% if (testFramework === 'jasmine') { %>
+    "expect": false,<% } %><% if (testFramework === 'jasmine') { %>
     "describe": false,
+    "xdescribe": false,
     "it": false,
+    "xit": false,
     "beforeEach": false,
     "afterEach": false,
     "expect": false,
-    "spyOn": false,
-    "xdescribe": false,
-    "xit": false<% } %>
+    "spyOn": false,<% } %>
+    "define": false
   }
 }

app/templates/micro-tmpl.coffee

@@ -1,5 +1,8 @@
 ###*
-@file <%= projName %> was created using generator-microjs.
-Generated on <%= (new Date).toISOString().split('T')[0] %> using <%= pkg.name %> v<%= pkg.version %>
-@author <%= realname %> <<%= email %>>
+  @file <%= projName %> was created using generator-microjs.
+  Scaffolded with <%= pkg.name %> v<%= pkg.version %>
+  @author <%= realname %> <<%= email %>>
 ###
+
+<%= exportName %> = ->
+  # TODO: implement your micro framework or library.

app/templates/micro-tmpl.js

@@ -1,6 +1,9 @@
 /**
  * @file <%= projName %> was created using generator-microjs.
- * Generated on <%= (new Date).toISOString().split('T')[0] %> using <%= pkg.name %> v<%= pkg.version %>
+ * Scaffolded with <%= pkg.name %> v<%= pkg.version %>
  * @author <%= realname %> <<%= email %>>
  */
-'use strict';
+
+function <%= exportName %>() {
+  // TODO: implement your micro framework or library.
+}