Merge pull request #39 from eapearson/master

npm dep updates, new dist.tgz build

Author: eapearson

.gitignore

@@ -1,5 +1,4 @@
-/nbproject/
 .DS_Store
 node_modules/
 bower_components/
-
+/dist/

build/Gruntfile.js

@@ -5,12 +5,12 @@ module.exports = function (grunt) {
     grunt.initConfig({
         pkg: grunt.file.readJSON('package.json'),
         copy: {
-            // 'pure-uuid': {
-            //     expand: true,
-            //     flatten: true,
-            //     src: 'node_modules/pure-uuid/uuid.js',
-            //     dest: '../src/plugin/iframe_root/modules/vendor/pure-uuid'
-            // }
+            'nunjucks': {
+                expand: true,
+                flatten: true,
+                src: 'node_modules/nunjucks/browser/nunjucks.js',
+                dest: '../src/plugin/iframe_root/modules/vendor/nunjucks'
+            }
         },
         clean: {
             options: {

build/README.md

@@ -8,6 +8,7 @@ By hand:
 
 ```
 cd build
+yarn install
 yarn clean
 yarn install
 yarn install-bower
@@ -16,10 +17,24 @@ yarn remove-source-maps
 yarn install-dist
 ```
 
+or
+
+```zsh
+yarn install && yarn clean && yarn install && yarn install-bower && yarn install-npm &&yarn remove-source-maps && yarn install-dist
+```
+
+or
+
+```zsh
+bash scripts/build.sh
+```
+
+(or your choice of shell - it is a very simple shell script without any special binding to a shell.)
+
 > Only use yarn clean if you want to clean out the stuff installed in vendor, as well as the node and bower packages installed in build.
 
 ## Preparing for a new release
 
-This plugin provides itself in the `dist` directory. In order to ensure that the dist directory is up-to-date with the source, run `yarn install-dist`.
+This plugin provides itself in the `dist.tgz` archive file, which is built via the temporary top level `dist` directory. In order to ensure that the dist directory is up-to-date with the source, run `yarn install-dist`.
 
-You can iterate on the raw source locally with `kbase-ui` by removing the dist directory temporarily, and supplying the plugin via the `plugins` option to kbase-ui's `make dev-start` task. kbase-ui will detect the absence of a dist directory and use the src directory instead.
+You can iterate on the raw source locally with `kbase-ui` by removing the dist directory, if it exists, and supplying the plugin via the `plugins` option to kbase-ui's `make dev-start` task. kbase-ui will map the internal plugin directory to the `src/plugin` directory within this repo.

build/bower.json

@@ -51,7 +51,6 @@
         "requirejs-text": "2.0.16",
         "requirejs-yaml": "eapearson/requirejs-yaml#1.0.5",
         "kbase-service-clients-js": "3.3.6",
-        "nunjucks": "3.1.2",
         "pure-uuid": "1.5.8",
         "spark-md5": "3.0.0",
         "font-awesome": "4.7.0",

build/package.json

@@ -22,6 +22,8 @@
         "grunt-contrib-copy": "1.0.0",
         "js-yaml": "3.13.1",
         "numeral": "2.0.6",
-        "terser": "4.4.3"
+        "nunjucks": "3.2.0",
+        "tar": "5.0.5",
+        "terser": "4.6.2"
     }
-}
+}

build/scripts/build.sh

@@ -0,0 +1,7 @@
+yarn install
+yarn clean
+yarn install
+yarn install-bower
+yarn install-npm
+yarn remove-source-maps
+yarn install-dist

build/scripts/install-dist.js

@@ -1,8 +1,12 @@
+/*eslint-env node */
+/*eslint strict: ["error", "global"] */
+'use strict';
 const bluebird = require('bluebird');
 const glob = bluebird.promisify(require('glob').Glob);
 const fs = bluebird.promisifyAll(require('fs-extra'));
 const Terser = require('terser');
 const path = require('path');
+const tar = require('tar');
 
 async function copyFiles(rootDir) {
     const root = rootDir.split('/');
@@ -61,6 +65,20 @@ async function minify(rootDir) {
     );
 }
 
+async function taritup(rootDir) {
+    const dir = 'dist';
+    const dest = rootDir.concat(['dist.tgz']).join('/');
+    console.log('tarring from ' + dir + ', to ' + dest);
+    return tar.c({
+        gzip: true,
+        file: dest,
+        portable: true,
+        cwd: rootDir.join('/')
+    }, [
+        dir
+    ]);
+}
+
 async function main() {
     const cwd = process.cwd().split('/');
     cwd.push('..');
@@ -70,6 +88,12 @@ async function main() {
     await copyFiles(projectPath);
     console.log('Minifying dist...');
     await minify(projectPath);
+    console.log('tar-ing dist...');
+    try {
+        await taritup(projectPath.split('/'));
+    } catch (ex) {
+        console.error('Error tarring up dist! ' + ex.message);
+    }
     console.log('done');
 }