added grunt to unify generating dist files (and eventually js linting)

added updated dist files from previous merged commit

Author: kontur

.gitignore

@@ -1 +1,3 @@
-.project
+.project
+node_modules
+bower_components

Gruntfile.js

@@ -0,0 +1,95 @@
+/*global module:false*/
+module.exports = function (grunt) {
+
+  // Project configuration.
+  grunt.initConfig({
+    // Metadata.
+    pkg: grunt.file.readJSON('package.json'),
+    banner: '/*! jquery.typer.js <%= pkg.version %>- <%= grunt.template.today("yyyy-mm-dd") %> */\n',
+    // Task configuration.
+    concat: {
+      options: {
+        banner: '<%= banner %>',
+        stripBanners: true
+      },
+      dist: {
+        src: ['src/jquery.typer.js'],
+        dest: 'dist/jquery.typer.js'
+      }
+    },
+    uglify: {
+      options: {
+        banner: '<%= banner %>'
+      },
+      dist: {
+        src: '<%= concat.dist.dest %>',
+        dest: 'dist/jquery.typer.min.js'
+      }
+    },
+    copy: {
+      dist: {
+        src:'src/jquery.typer.js',
+        dest: 'dist/jquery.typer.js'
+      }
+    },
+    jshint: {
+      options: {
+        curly: true,
+        eqeqeq: true,
+        immed: true,
+        latedef: true,
+        newcap: true,
+        noarg: true,
+        sub: true,
+        undef: true,
+        unused: true,
+        boss: true,
+        eqnull: true,
+        browser: true,
+        globals: {
+          jQuery: true
+        }
+      },
+      gruntfile: {
+        src: 'Gruntfile.js'
+      },
+      dist: {
+        options: {
+          curly: true,
+          eqeqeq: true,
+          immed: true,
+          latedef: true,
+          newcap: true,
+          noarg: true,
+          sub: true,
+          undef: true,
+          unused: true,
+          boss: true,
+          eqnull: true,
+          browser: true,
+          globals: {
+            jQuery: true
+          }
+        },
+        src: 'src/jquery.typer.js'
+      }
+    },
+    watch: {
+      gruntfile: {
+        files: '<%= jshint.gruntfile.src %>',
+        tasks: ['jshint:gruntfile']
+      }
+    }
+  });
+
+  // These plugins provide necessary tasks.
+  grunt.loadNpmTasks('grunt-contrib-concat');
+  grunt.loadNpmTasks('grunt-contrib-uglify');
+  grunt.loadNpmTasks('grunt-contrib-jshint');
+  grunt.loadNpmTasks('grunt-contrib-watch');
+  grunt.loadNpmTasks('grunt-contrib-copy');
+
+  // Default task.
+  grunt.registerTask('dist', [/*'jshint:dist', */'concat:dist', 'uglify:dist', 'copy:dist']);
+
+};

README.md

@@ -47,6 +47,11 @@ Set the options individually:
 ```javascript
 $.typer.options.highlightSpeed = 500;
 ```
+
+## Contributing
+
+Make your changes on `src/jquery.typer.js`. To generate updated minified distribution versions run `$ grunt dist`.
+
 ## About
 
 jquery.typer.js was originally developed for [LayerVault](http://layervault.com) by [Kelly Sutton](http://kellysutton.com).

dist/jquery.typer.js

@@ -11,34 +11,21 @@ String.prototype.rightChars = function(n){
 };
 
 (function($) {
-  var
-    options = {
-      highlightSpeed    : 20,
-      typeSpeed         : 100,
-      clearDelay        : 500,
-      typeDelay         : 200,
-      clearOnHighlight  : true,
-      highlightEverything: true,
-      typerDataAttr     : 'data-typer-targets',
-      typerInterval     : 2000,
-      debug             : false,
-      tapeColor         : 'auto',
-      typerOrder        : 'random',
-    },
-    highlight,
-    clearText,
-    backspace,
-    type,
-    spanWithColor,
-    clearDelay,
-    typeDelay,
-    clearData,
-    isNumber,
-    typeWithAttribute,
-    getHighlightInterval,
-    getTypeInterval,
-    intervalHandle,
-    typerInterval;
+  var opts,
+      highlight,
+      clearText,
+      backspace,
+      type,
+      spanWithColor,
+      clearDelay,
+      typeDelay,
+      clearData,
+      isNumber,
+      typeWithAttribute,
+      getHighlightInterval,
+      getTypeInterval,
+      intervalHandle,
+      typerInterval;
 
   spanWithColor = function(color, backgroundColor) {
     if (color === 'rgba(0, 0, 0, 0)') {
@@ -83,7 +70,6 @@ String.prototype.rightChars = function(n){
       return;
     }
 
-
     $e.text(
       oldLeft +
       text.charAt(0) +
@@ -136,7 +122,7 @@ String.prototype.rightChars = function(n){
       .append(
         spanWithColor(
             $e.data('backgroundColor'),
-            $.typer.options.tapeColor === 'auto' ? $e.data('primaryColor') : $.typer.options.tapeColor
+            opts.tapeColor === 'auto' ? $e.data('primaryColor') : opts.tapeColor
           )
           .append(highlightedText)
       )
@@ -160,47 +146,40 @@ String.prototype.rightChars = function(n){
       }
 
       try {
-        targets = JSON.parse($e.attr($.typer.options.typerDataAttr)).targets;
+        targets = JSON.parse($e.attr(opts.typerDataAttr)).targets;
       } catch (e) {}
 
       if (typeof targets === "undefined") {
-        targets = $.map($e.attr($.typer.options.typerDataAttr).split(','), function (e) {
+        targets = $.map($e.attr(opts.typerDataAttr).split(','), function (e) {
           return $.trim(e);
         });
       }
 
-      if ($.typer.options.typerOrder == 'random') {
+      if (opts.typerOrder == 'random') {
         $e.typeTo(targets[Math.floor(Math.random()*targets.length)]);
       }
-      else if ($.typer.options.typerOrder == 'sequential') {
+      else if (opts.typerOrder == 'sequential') {
         $e.typeTo(targets[last]);
         last = (last < targets.length - 1) ? last + 1 : 0;
       }
       else {
-        console.error("Type order of '" + $.typer.options.typerOrder + "' not supported");
+        console.error("Type order of '" + opts.typerOrder + "' not supported");
         clearInterval(intervalHandle);
       }
-    }
-  })();
-
-  // Expose our options to the world.
-  $.typer = (function () {
-    return { options: options };
+    };
   })();
 
-  $.extend($.typer, {
-    options: options
-  });
-
   //-- Methods to attach to jQuery sets
 
-  $.fn.typer = function() {
+  $.fn.typer = function(options) {
     var $elements = $(this);
 
+    opts = jQuery.extend({}, $.fn.typer.defaults, options);
+
     return $elements.each(function () {
       var $e = $(this);
 
-      if (typeof $e.attr($.typer.options.typerDataAttr) === "undefined") {
+      if (typeof $e.attr(opts.typerDataAttr) === "undefined") {
         return;
       }
 
@@ -219,22 +198,22 @@ String.prototype.rightChars = function(n){
       j = 0;
 
     if (currentText === newString) {
-      if ($.typer.options.debug === true) {
+      if (opts.debug === true) {
         console.log("Our strings our equal, nothing to type");
       }
       return $e;
     }
 
     if (currentText !== $e.html()) {
-      if ($.typer.options.debug === true) {
+      if (opts.debug === true) {
         console.error("Typer does not work on elements with child elements.");
       }
       return $e;
     }
 
     $e.data('typing', true);
 
-    if ($.typer.options.highlightEverything !== true) {
+    if (opts.highlightEverything !== true) {
       while (currentText.charAt(i) === newString.charAt(i)) {
         i++;
       }
@@ -251,7 +230,7 @@ String.prototype.rightChars = function(n){
       oldRight: currentText.rightChars(j - 1),
       leftStop: i,
       rightStop: currentText.length - j,
-      primaryColor: $.typer.options.tapeColor === 'auto' ? $e.data('primaryColor') : $.typer.options.tapeColor,
+      primaryColor: opts.tapeColor === 'auto' ? $e.data('primaryColor') : opts.tapeColor,
       backgroundColor: $e.css('background-color'),
       text: newString
     });
@@ -264,22 +243,37 @@ String.prototype.rightChars = function(n){
   //-- Helper methods. These can one day be customized further to include things like ranges of delays.
 
   getHighlightInterval = function () {
-    return $.typer.options.highlightSpeed;
+    return opts.highlightSpeed;
   };
 
   getTypeInterval = function () {
-    return $.typer.options.typeSpeed;
-  },
+    return opts.typeSpeed;
+  };
 
   clearDelay = function () {
-    return $.typer.options.clearDelay;
-  },
+    return opts.clearDelay;
+  };
 
   typeDelay = function () {
-    return $.typer.options.typeDelay;
+    return opts.typeDelay;
   };
 
   typerInterval = function () {
-    return $.typer.options.typerInterval;
+    return opts.typerInterval;
   };
+
+  $.fn.typer.defaults = {
+    highlightSpeed      : 20,
+    typeSpeed           : 100,
+    clearDelay          : 500,
+    typeDelay           : 200,
+    clearOnHighlight    : true,
+    highlightEverything : true,
+    typerDataAttr       : 'data-typer-targets',
+    typerInterval       : 2000,
+    debug               : false,
+    tapeColor           : 'auto',
+    typerOrder          : 'random',
+  };
+
 })(jQuery);

dist/jquery.typer.min.js

@@ -0,0 +1,34 @@
+{
+  "name": "jquery.typer.js",
+  "version": "1.0.0",
+  "description": "A simple jQuery plugin for a slick typing effect.",
+  "main": "Gruntfile.js",
+  "dependencies": {},
+  "devDependencies": {
+    "grunt": "^0.4.5",
+    "grunt-contrib-concat": "^0.5.1",
+    "grunt-contrib-copy": "^0.8.0",
+    "grunt-contrib-jshint": "^0.11.1",
+    "grunt-contrib-uglify": "^0.8.0",
+    "grunt-contrib-watch": "^0.6.1"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kontur/jquery.typer.js.git"
+  },
+  "keywords": [
+    "jquery",
+    "typer",
+    "typing",
+    "typewriter",
+    "text"
+  ],
+  "author": "Johannes Neumeier <hello@johannesneumeier.com>",
+  "bugs": {
+    "url": "https://github.com/kontur/jquery.typer.js/issues"
+  },
+  "homepage": "https://github.com/kontur/jquery.typer.js"
+}