Ported to Gulp (#30)

* Ported to Gulp * Update README.md * Update package.json * Update README.md * Delete Makefile
marcelklehr · Dec 18, 2017 · a737e3d · a737e3d
1 parent 4547753
commit a737e3d
Show file tree

Hide file tree

Showing 6 changed files with 98 additions and 35 deletions.
diff --git a/Gulpfile.js b/Gulpfile.js
@@ -0,0 +1,45 @@
+var gulp = require('gulp');
+var concat = require('gulp-concat');
+var uglify = require('gulp-uglify');
+var filesExist = require('files-exist');
+var jshint = require('gulp-jshint');
+
+js_top_file = 'module-wrapper-top.js';
+js_bottom_file = 'module-wrapper-bottom.js';
+
+js_files = [
+    'socialcalcconstants.js',
+    'socialcalc-3.js',
+    'socialcalctableeditor.js',
+    'formatnumber2.js',
+    'formula1.js',
+    'socialcalcpopup.js',
+    'socialcalcspreadsheetcontrol.js',
+    'socialcalcviewer.js'
+];
+
+gulp.task('validate-js', function () {
+    for (js_file of filesExist(js_files)) {
+        gulp.src(js_file)
+            .pipe(jshint())
+            .pipe(jshint.reporter('jshint-stylish'));
+    }
+
+    // We need the wrapper to be complete in order to process it.
+    var module_wrapper_files = filesExist([js_top_file, js_bottom_file]);
+    gulp.src(module_wrapper_files)
+        .pipe(concat('module-wrapper.js'))
+        .pipe(jshint())
+        .pipe(jshint.reporter('jshint-stylish'));
+});
+
+
+gulp.task('js', ['validate-js'], function () {
+    var files = filesExist([].concat(js_top_file, js_files, js_bottom_file));
+    return gulp.src(files)
+        .pipe(concat('SocialCalc.js'))
+        .pipe(gulp.dest('.'));
+});
+
+gulp.task('default', ['js'], function () {});
+
diff --git a/Makefile b/Makefile
diff --git a/README.md b/README.md
@@ -18,6 +18,17 @@ socialCalcControl.InitializeSpreadsheetControl(el /*, height, width, spacebelow*
 
 This package also works in node.js. You don't need to callc `InitializeSpreadsheetControl` here, because that is just initializing the rendering.
 
+## Build from sources
+
+SocialCalc uses npm and gulp, to get the dependencies, use:
+```bash
+npm install
+```
+You can now compile the project using
+```bash
+npm run build
+```
+
 ## Licensing
 ### Common Public Attribution License (Socialtext Inc.)
 * socialcalcspreadsheetcontrol.js

diff --git a/SocialCalc.js b/SocialCalc.js
@@ -15,6 +15,7 @@
         root.SocialCalc = factory.call(root, this);
   }
 }(this, function (window) {
+
 //
 /*
 // The module of the SocialCalc package with customizable constants, strings, etc.
@@ -900,6 +901,7 @@ SocialCalc.ConstantsSetImagePrefix = function(imagePrefix) {
 
    }
 
+
 //
 // The main SocialCalc code module of the SocialCalc package
 //
@@ -7392,6 +7394,7 @@ SocialCalc.SetConvertedCell = function(sheet, cr, rawvalue) {
 
    }
 
+
 //
 // SocialCalcTableEditor
 //
@@ -13820,6 +13823,7 @@ SocialCalc.ProcessKey = function (ch, e) {
    }
 
 
+
 //
 /*
 // SocialCalc Number Formatting Library
@@ -14850,6 +14854,7 @@ SocialCalc.intFunc = function(n) {
       }
    }
 
+
 //
 //
 /*
@@ -21375,6 +21380,7 @@ SocialCalc.Formula.TestCriteria = function(value, type, criteria) {
    return cond;
 
    }
+
 //
 /*
 // The module of the SocialCalc package for the optional popup menus in socialcalcspreadsheetcontrol.js
@@ -22995,6 +23001,7 @@ SocialCalc.Popup.Types.ColorChooser.CloseOK = function(e) {
 
    }
 
+
 //
 // SocialCalcSpreadsheetControl
 //
@@ -26891,6 +26898,7 @@ SocialCalc.CtrlSEditorDone = function(idprefix, whichpart) {
 
    }
 
+
 //
 // SocialCalcViewer
 //
@@ -27604,18 +27612,19 @@ str = str.replace(/([^\n])\r([^\n])/g, "$1\r\n$2");
 
 // END OF FILE
 
+
 if('undefined' === typeof document) {
-  // We don't really need a DOM-based presentation layer on the server
-  SocialCalc.GetEditorCellElement = function () {};
-  SocialCalc.ReplaceCell = function () {};
-  SocialCalc.EditorRenderSheet = function () {};
-  SocialCalc.SpreadsheetControlSortSave = function () { return "" };
-  SocialCalc.SpreadsheetControlStatuslineCallback = function () {};
-  SocialCalc.DoPositionCalculations = function (editor) {
-      SocialCalc.EditorSheetStatusCallback(
-	  null, "doneposcalc", null, editor
-      );
-  }
+    // We don't really need a DOM-based presentation layer on the server
+    SocialCalc.GetEditorCellElement = function () {};
+    SocialCalc.ReplaceCell = function () {};
+    SocialCalc.EditorRenderSheet = function () {};
+    SocialCalc.SpreadsheetControlSortSave = function () { return ""; };
+    SocialCalc.SpreadsheetControlStatuslineCallback = function () {};
+    SocialCalc.DoPositionCalculations = function (editor) {
+        SocialCalc.EditorSheetStatusCallback(
+            null, "doneposcalc", null, editor
+        );
+    };
 }
 
 // Compatibility with webworker-threads

diff --git a/module-wrapper-bottom.js b/module-wrapper-bottom.js
@@ -1,15 +1,15 @@
 if('undefined' === typeof document) {
-  // We don't really need a DOM-based presentation layer on the server
-  SocialCalc.GetEditorCellElement = function () {};
-  SocialCalc.ReplaceCell = function () {};
-  SocialCalc.EditorRenderSheet = function () {};
-  SocialCalc.SpreadsheetControlSortSave = function () { return "" };
-  SocialCalc.SpreadsheetControlStatuslineCallback = function () {};
-  SocialCalc.DoPositionCalculations = function (editor) {
-      SocialCalc.EditorSheetStatusCallback(
-	  null, "doneposcalc", null, editor
-      );
-  }
+    // We don't really need a DOM-based presentation layer on the server
+    SocialCalc.GetEditorCellElement = function () {};
+    SocialCalc.ReplaceCell = function () {};
+    SocialCalc.EditorRenderSheet = function () {};
+    SocialCalc.SpreadsheetControlSortSave = function () { return ""; };
+    SocialCalc.SpreadsheetControlStatuslineCallback = function () {};
+    SocialCalc.DoPositionCalculations = function (editor) {
+        SocialCalc.EditorSheetStatusCallback(
+            null, "doneposcalc", null, editor
+        );
+    };
 }
 
 // Compatibility with webworker-threads

diff --git a/package.json b/package.json
@@ -4,6 +4,7 @@
   "description": "Collaborative spreadsheet editor",
   "main": "SocialCalc.js",
   "scripts": {
+    "build": "gulp",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
@@ -28,5 +29,14 @@
   "bugs": {
     "url": "https://github.com/marcelklehr/socialcalc/issues"
   },
-  "homepage": "https://github.com/marcelklehr/socialcalc#readme"
+  "homepage": "https://github.com/marcelklehr/socialcalc#readme",
+  "devDependencies": {
+    "gulp": "^3.9.1",
+    "gulp-jshint": "^2.0.4",
+    "jshint": "^2.9.5",
+    "jshint-stylish": "^2.2.1",
+    "gulp-uglify": "^3.0.0",
+    "gulp-concat": "^2.6.1",
+    "files-exist": "^1.0.2"
+  }
 }