Add compile step that bundles and compresses JS files

Also, manage dependencies on third-party JS libraries using NPM.

Author: timjb

.ghc.environment.x86_64-darwin-8.2.1

@@ -0,0 +1,60 @@
+-- This is a GHC environment file written by cabal. This means you can
+-- run ghc or ghci and get the environment of the project as a whole.
+-- But you still need to use cabal repl $target to get the environment
+-- of specific components (libs, exes, tests etc) because each one can
+-- have its own source dirs, cpp flags etc.
+-- 
+clear-package-db
+global-package-db
+package-db /Users/tim/.cabal/store/ghc-8.2.1/package.db
+package-db dist-newstyle/packagedb/ghc-8.2.1
+package-id base-4.10.0.0
+package-id rts
+package-id ghc-prim-0.5.1.0
+package-id integer-gmp-1.0.1.0
+package-id hspec-2.4.4-1c0b7d85ed834bde9b4fc0b67ffdca678fb05d0af151729fbb5937f90ecdebc4
+package-id hspec-core-2.4.4-807f12cd77dd6a3dc843790305e601dab88a824d262b2c9e4c52d31bdd7b4fe1
+package-id random-1.1-b5eae019205c436b65168623eadccb282a3368907e99b2197b8bf5ebbec87f10
+package-id time-1.8.0.2
+package-id deepseq-1.4.3.0
+package-id array-0.5.2.0
+package-id tf-random-0.5-9bcd920a3a53dfcdddf523c638d6ca0c5f5c8671008ea5e6e5966877654bf079
+package-id primitive-0.6.2.0-591913180aa7f665eb70f8649d947be41cc43927c33726da89f290095fa8dcf9
+package-id transformers-0.5.2.0
+package-id setenv-0.1.1.3-ac84fe3b56537f48ca8e0c15ab0cdb316e931e007a5785006135f58fe4313487
+package-id unix-2.7.2.2
+package-id bytestring-0.10.8.2
+package-id ansi-terminal-0.7.1.1-68169ce6c2f32f3c680ddaed58b58b2432bb4633791f154517abcc5ec1dc2abc
+package-id colour-2.3.3-777ceaf5f7b3188ef40ce15f303fcfcc6af0e44dd851955504a6bed0f8cb0f89
+package-id HUnit-1.6.0.0-9d0216c0eeea94fdc2364f3daab9b84f498800caebb2378a6b5b312fb8ab2ad0
+package-id call-stack-0.1.0-91535ce8ed4646395bd69e2e573fd77bbd01ffa7fa07519e2aa1790ce3d68fd9
+package-id QuickCheck-2.10.0.1-14eb05fbce793c97a6246c29bb7eafdea93c9e191233397d253a0cb33298aba6
+package-id containers-0.5.10.2
+package-id template-haskell-2.12.0.0
+package-id ghc-boot-th-8.2.1
+package-id pretty-1.1.3.3
+package-id quickcheck-io-0.2.0-25165274c80769eeb2ddb4eda44ea8f611449ead2858e2e61e8faf5ca0f61874
+package-id hspec-expectations-0.8.2-52a51410f728d3bc36fff2a4f669f158292d5541a1e00bbf6e17357c8e76ade8
+package-id async-2.1.1.1-a942400ba4fb0746be04a00b270f56696159d0e9149449689d86630a183715c9
+package-id stm-2.4.4.1-b93cc6a1c82b736dcfa75ec5908a8462866a07e9ecbfb5920c82efe10a147d6e
+package-id directory-1.3.0.2
+package-id filepath-1.4.1.2
+package-id hspec-discover-2.4.4-c0abb7aa79913de4aae506b6a6b18b2233bb2f1e4659ada9231344caca718079
+package-id haddock-api-2.18.2-inplace
+package-id Cabal-2.0.0.2
+package-id process-1.6.1.0
+package-id binary-0.8.5.1
+package-id ghc-8.2.1
+package-id hpc-0.6.0.3
+package-id ghc-boot-8.2.1
+package-id ghci-8.2.1
+package-id hoopl-3.10.2.2
+package-id terminfo-0.4.1.0
+package-id ghc-paths-0.1.0.9-013a97aeac002a1773522f13287773439d3c51c3200fb2bdf7f3c1de6f4e279b
+package-id haddock-library-1.4.6-inplace
+package-id haddock-library-1.4.6-inplace-attoparsec
+package-id xhtml-3000.2.2
+package-id haddock-test-0.0.1-inplace
+package-id xml-1.3.14-def5148bc6a54ed5ad89b9a71f36a9790f07dd65f92400fb8b2061cf6efb977f
+package-id text-1.2.2.2-52fc6c4fafb6b898175bc0eadd29d6b55afd242510914ad1ce3e65ab2ddf155d
+package-id syb-0.7-b0a8286f677ef2728b0c581fd92d9ed16d8ec958d4417c04fd24494069b0c8d1

.gitignore

@@ -19,6 +19,8 @@
 tags
 TAGS
 
+/haddock-api/resources/html/node_modules
+
 .cabal-sandbox
 cabal.sandbox.config
 

haddock-api/haddock-api.cabal

@@ -20,11 +20,9 @@ extra-source-files:
 data-dir:
   resources
 data-files:
-  html/index.js
-  html/fuse.js
-  html/preact.js
+  html/quick-jump.min.js
+  html/haddock-bundle.min.js
   html/solarized.css
-  html/haddock-util.js
   html/highlight.js
   html/Classic.theme/haskell_icon.gif
   html/Classic.theme/minus.gif

haddock-api/resources/html/README.md

@@ -0,0 +1,13 @@
+# Compiling
+
+* Install [node](https://nodejs.org/) and [npm](https://www.npmjs.com)
+* Run `npm install` and `npm install gulp-cli -g` in this directory.
+* Run `gulp` in this directory. This rebuilds the minified JS files.
+
+# Manual Testing
+
+Generate haddock docs for some Haskell project and replace the generated JS files:
+
+```
+gulp && cp *.min.js path-to/generated-haddock-docs
+```

haddock-api/resources/html/fuse.js

@@ -0,0 +1,22 @@
+const gulp = require('gulp');
+const uglify = require('gulp-uglify');
+const browserify = require('browserify');
+const source = require('vinyl-source-stream');
+const buffer = require('vinyl-buffer');
+
+function buildJS(targetFileName, files) {
+  var b = browserify({ entries: files });
+  return b
+    .bundle()
+    .pipe(source(targetFileName))
+    .pipe(buffer())
+    .pipe(uglify().on('error', function(e) { console.log(e); }))
+    .pipe(gulp.dest('.'));
+}
+
+gulp.task('build-js', function() {
+  buildJS('quick-jump.min.js', ['./js-src/quick-jump.js']);
+  buildJS('haddock-bundle.min.js', ['./js-src/init.js']);
+});
+
+gulp.task('default', ['build-js']);

haddock-api/resources/html/gulpfile.js

@@ -56,6 +56,9 @@ function toggleSection(id)
   return b;
 }
 
+// TODO: get rid of global variables
+if (typeof window !== 'undefined') { window.toggleSection = toggleSection; }
+
 var collapsed = {};
 function rememberCollapsed(id)
 {
@@ -88,6 +91,8 @@ function restoreCollapsed()
   }
 }
 
+exports.restoreCollapsed = restoreCollapsed;
+
 function setCookie(name, value) {
   document.cookie = name + "=" + escape(value) + ";path=/;";
 }
@@ -145,6 +150,8 @@ function addStyleMenu() {
   }
 }
 
+exports.addStyleMenu = addStyleMenu;
+
 function setActiveStyleSheet(title) {
   var as = styles();
   var i, a, found;
@@ -171,16 +178,9 @@ function resetStyle() {
   if (s) setActiveStyleSheet(s);
 }
 
+exports.resetStyle = resetStyle;
 
 function styleMenu(show) {
   var m = document.getElementById('style-menu');
   if (m) toggleShow(m, show);
-}
-
-
-function pageLoad() {
-  addStyleMenu();
-  resetStyle();
-  restoreCollapsed();
-}
-
+}

haddock-api/resources/html/haddock-bundle.min.js

@@ -0,0 +1,21 @@
+var util = require('./haddock-util');
+var quickJump = require('./quick-jump');
+
+function onDomReady(callback) {
+  if (document.readyState === 'interactive') {
+    callback();
+  } else {
+    document.addEventListener('readystatechange', function () {
+      if (document.readyState === 'interactive') {
+        callback();
+      }
+    });
+  }
+}
+
+onDomReady(function() {
+  util.addStyleMenu();
+  util.resetStyle();
+  util.restoreCollapsed();
+  quickJump.init();
+});

haddock-api/resources/html/haddock-util.js renamed to haddock-api/resources/html/js-src/haddock-util.js

@@ -1,3 +1,6 @@
+var Fuse = require('fuse.js');
+var preact = require('preact');
+
 quickNav = (function() {
 
 var baseUrl;
@@ -230,7 +233,7 @@ var App = createClass({
             onFocus: this.show.bind(this),
             onClick: this.show.bind(this),
             onInput: this.updateResults.bind(this)
-          }),
+          })
         ),
         h('div', {
           id: 'search-results',
@@ -276,8 +279,8 @@ var App = createClass({
           : h('li', { class: 'more-results' },
               this.actionLink(expand, {}, "show " + (items.length - visibleItems.length) + " more results from this module")
             )
-      ),
-    )
+      )
+    );
   },
 
   navigationLink: function(href, attrs) {
@@ -355,13 +358,13 @@ var KeyboardShortcuts = function() {
     h('tr', null,
       h('td', null, h('span', { class: 'key' }, "↵")),
       h('td', null, "Go to active search result")
-    ),
+    )
   );
 };
 
 var IntroMsg = function() {
   return h('p', null,
-    "You can find any exported type, constructor, class, function or pattern defined in this package by (approximate) name.",
+    "You can find any exported type, constructor, class, function or pattern defined in this package by (approximate) name."
   );
 };
 
@@ -374,10 +377,10 @@ var NoResultsMsg = function(props) {
     ),
     h('p', null,
       h('code', null, 'Nothing'),
-      " matches your query for '" + props.searchString + "'.",
+      " matches your query for '" + props.searchString + "'."
     ),
     h('p', null,
-      h('code', null, 'Left "no matches for \'' + props.searchString + '\'" :: Either String (NonEmpty SearchResult)'),
+      h('code', null, 'Left "no matches for \'' + props.searchString + '\'" :: Either String (NonEmpty SearchResult)')
     )
   ];
 
@@ -392,3 +395,5 @@ return {
   }
 }
 })();
+
+if (typeof exports === 'object') { exports.init = quickNav.init; }