Minor changes to make sigma publishable to NPM

jacomyal · jacomyal · commit 94a687c80a3d · 2014-04-03T16:10:03.000+02:00
Fixing jacomyal#186. Here are some more details about the commit itself: - Updated conrad.js - Added a dirty script to fix exports: sigma.export.js - Fixed last references to window - Added the npmPrePublish Grunt task, and linked it to `npm prepublish` - Added .npmignore rules and fixed some in .gitignore - Updated package.json, changing the name from "sigma-js" to "sigma"
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 node_modules/*
 build/*
+*.tgz
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,13 @@
+build/*
+!build/sigma.require.js
+!build/sigma.min.js
+!build/plugins/*
+test/*
+node_modules/*
+examples/*
+Gruntfile.js
+CHANGELOG.md
+.travis.yml
+.gitignore
+*.tgz
+*.log
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -49,6 +49,9 @@ module.exports = function(grunt) {
     'src/misc/sigma.misc.drawHovers.js'
   ];
 
+  var npmJsFiles = coreJsFiles.slice(0);
+  npmJsFiles.splice(2, 0, 'src/sigma.export.js');
+
   var pluginFiles = [
     'plugins/sigma.layout.forceAtlas2/*.js',
     'plugins/sigma.parsers.gexf/*.js',
@@ -110,11 +113,15 @@ module.exports = function(grunt) {
     },
     concat: {
       options: {
-        separator: ';'
+        separator: '\n'
       },
       dist: {
         src: coreJsFiles,
         dest: 'build/sigma.js'
+      },
+      require: {
+        src: npmJsFiles,
+        dest: 'build/sigma.require.js'
       }
     },
     sed: {
@@ -147,6 +154,7 @@ module.exports = function(grunt) {
   // By default, will check lint, hint, test and minify:
   grunt.registerTask('default', ['closureLint', 'jshint', 'qunit', 'sed', 'uglify']);
   grunt.registerTask('release', ['closureLint', 'jshint', 'qunit', 'sed', 'uglify', 'zip']);
+  grunt.registerTask('npmPrePublish', ['uglify:plugins', 'concat:require']);
 
   // For travis-ci.org, only launch tests:
   grunt.registerTask('travis', ['qunit']);
diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "sigma-js",
+  "name": "sigma",
   "version": "1.0.2",
   "description": "A JavaScript library dedicated to graph drawing.",
   "homepage": "http://sigmajs.org",
@@ -9,6 +9,7 @@
     "url": "http://github.com/jacomyal/sigma.js.git"
   },
   "license": "MIT",
+  "main": "build/sigma.require.js",
   "devDependencies": {
     "grunt-cli": "^0.1.13",
     "grunt": "~0.4.4",
@@ -25,6 +26,7 @@
   "scripts": {
     "start": "http-server -p 8000",
     "test": "grunt travis",
-    "build": "grunt uglify"
+    "build": "grunt uglify",
+    "prepublish": "grunt npmPrePublish"
   }
 }
diff --git a/src/conrad.js b/src/conrad.js
@@ -979,6 +979,6 @@
     if (typeof module !== 'undefined' && module.exports)
       exports = module.exports = conrad;
     exports.conrad = conrad;
-  } else
-    global.conrad = conrad;
+  }
+  global.conrad = conrad;
 })(this);
diff --git a/src/renderers/sigma.renderers.def.js b/src/renderers/sigma.renderers.def.js
@@ -1,4 +1,4 @@
-;(function(undefined) {
+;(function(global) {
   'use strict';
 
   if (typeof sigma === 'undefined')
@@ -9,7 +9,7 @@
 
   // Check if WebGL is enabled:
   var canvas,
-      webgl = !!window.WebGLRenderingContext;
+      webgl = !!global.WebGLRenderingContext;
   if (webgl) {
     canvas = document.createElement('canvas');
     webgl = !!(
@@ -22,4 +22,4 @@
   sigma.renderers.def = webgl ?
     sigma.renderers.webgl :
     sigma.renderers.canvas;
-}).call(this);
+})(this);
diff --git a/src/sigma.core.js b/src/sigma.core.js
@@ -647,11 +647,7 @@
    */
   if (typeof this.sigma !== 'undefined')
     throw 'An object called sigma is already in the global scope.';
-  else if (typeof exports !== 'undefined') {
-    if (typeof module !== 'undefined' && module.exports)
-      exports = module.exports = sigma;
-    exports.sigma = sigma;
-  } else
-    this.sigma = sigma;
+
+  this.sigma = sigma;
 
 }).call(this);
diff --git a/src/sigma.export.js b/src/sigma.export.js
@@ -0,0 +1,11 @@
+// Hardcoded export for the node.js version:
+var sigma = this.sigma,
+    conrad = this.conrad;
+
+sigma.conrad = conrad;
+
+if (typeof exports !== 'undefined') {
+  if (typeof module !== 'undefined' && module.exports)
+    exports = module.exports = sigma;
+  exports.sigma = sigma;
+}
diff --git a/src/utils/sigma.polyfills.js b/src/utils/sigma.polyfills.js
@@ -1,4 +1,4 @@
-;(function(undefined) {
+;(function(global) {
   'use strict';
 
   /**
@@ -12,19 +12,19 @@
       lastTime = 0,
       vendors = ['ms', 'moz', 'webkit', 'o'];
 
-  for (x = 0; x < vendors.length && !window.requestAnimationFrame; x++) {
-    window.requestAnimationFrame =
-      window[vendors[x] + 'RequestAnimationFrame'];
-    window.cancelAnimationFrame =
-      window[vendors[x] + 'CancelAnimationFrame'] ||
-      window[vendors[x] + 'CancelRequestAnimationFrame'];
+  for (x = 0; x < vendors.length && !global.requestAnimationFrame; x++) {
+    global.requestAnimationFrame =
+      global[vendors[x] + 'RequestAnimationFrame'];
+    global.cancelAnimationFrame =
+      global[vendors[x] + 'CancelAnimationFrame'] ||
+      global[vendors[x] + 'CancelRequestAnimationFrame'];
   }
 
-  if (!window.requestAnimationFrame)
-    window.requestAnimationFrame = function(callback, element) {
+  if (!global.requestAnimationFrame)
+    global.requestAnimationFrame = function(callback, element) {
       var currTime = new Date().getTime(),
           timeToCall = Math.max(0, 16 - (currTime - lastTime)),
-          id = window.setTimeout(
+          id = global.setTimeout(
             function() {
               callback(currTime + timeToCall);
             },
@@ -35,8 +35,8 @@
       return id;
     };
 
-  if (!window.cancelAnimationFrame)
-    window.cancelAnimationFrame = function(id) {
+  if (!global.cancelAnimationFrame)
+    global.cancelAnimationFrame = function(id) {
       clearTimeout(id);
     };
 
@@ -74,4 +74,4 @@
 
       return fBound;
     };
-}).call(this);
+})(this);

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`node_modules/*`
`2`	`2`	`build/*`
	`3`	`+*.tgz`