Merge branch 'es6'

Author: valeriangalliat

.gitignore

@@ -1,6 +1,7 @@
-node_modules
+/assets/css/main.css.map
+/dist
+/node_modules
+/sassdoc
 .DS_Store
 .sass-cache
 npm-debug.log
-assets/css/main.css.map
-sassdoc/

.jshintrc

@@ -0,0 +1,3 @@
+{
+  "esnext": true
+}

Makefile

@@ -1,7 +1,18 @@
-SASS = sass
-UGLIFY = node_modules/uglify-js/bin/uglifyjs
+PATH := $(PWD)/node_modules/.bin:$(PATH)
 
-all: sass min
+SOURCES := $(wildcard src/*.js)
+DIST := $(SOURCES:src/%=dist/%)
+
+all: lint dist min sass
+
+lint:
+	jshint $(SOURCES)
+
+dist: $(DIST)
+
+dist/%.js: src/%.js
+	mkdir -p $(@D)
+	6to5 --optional selfContained $< -o $@
 
 min: assets/js/main.min.js
 
@@ -11,10 +22,12 @@ assets/js/main.min.js: \
 	assets/js/search.js \
 	assets/js/main.js \
 	assets/js/vendor/prism.min.js
-	cat $^ | $(UGLIFY) > $@
+	cat $^ | uglifyjs > $@
 
 sass:
-	$(SASS) --update scss:assets/css --style compressed
+	sass --update scss:assets/css --style compressed
 
 clean:
-	$(RM) -r assets/js/main.min.js assets/css
+	rm -rf $(DIST) assets/js/main.min.js assets/css
+
+.PHONY: all dist min sass clean

default.json

@@ -1,5 +1,11 @@
 {
   "display": {
+    "annotations": {
+      "function": ["description", "parameter", "return", "example", "throw", "require", "usedby", "since", "see", "todo", "link", "author"],
+      "mixin": ["description", "parameter", "content", "output", "example", "throw", "require", "usedby", "since", "see", "todo", "link", "author"],
+      "placeholder": ["description", "example", "throw", "require", "usedby", "since", "see", "todo", "link", "author"],
+      "variable": ["description", "type", "property", "require", "example", "usedby", "since", "see", "todo", "link", "author"]
+    },
     "access": ["public", "private"],
     "alias": false,
     "watermark": true

index.js

@@ -3,7 +3,7 @@
   "description": "SassDoc's default theme",
   "title": "SassDoc Default Theme",
   "author": "SassDoc team",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "keywords": [
     "sassdoc-theme"
   ],
@@ -14,22 +14,27 @@
   "files": [
     "assets",
     "views",
+    "dist",
     "default.json",
     "index.js",
     "LICENSE.md",
     "README.md"
   ],
+  "main": "dist",
   "dependencies": {
-    "bluebird": "^2.8.2",
+    "6to5-runtime": "^3.2.1",
     "chroma-js": "^0.6.3",
     "extend": "^1.0.0",
+    "fs-extra": "^0.1.0",
     "html-minifier": "^0.6.9",
+    "promise-denodeify": "^1.2.2",
     "sassdoc-extras": "^2.0.0",
     "swig": "1.4.0",
-    "swig-extras": "^0.0.1",
-    "themeleon": "^3.0.0"
+    "swig-extras": "^0.0.1"
   },
   "devDependencies": {
+    "6to5": "^3.2.1",
+    "jshint": "^2.6.0",
     "uglify-js": "^2.4.15"
   }
 }

package.json

@@ -0,0 +1,53 @@
+import chroma from 'chroma-js';
+import def from '../default';
+import denodeify from 'promise-denodeify';
+import extend  from 'extend';
+import fs from 'fs';
+import fse from 'fs-extra';
+import { minify } from 'html-minifier';
+import path from 'path';
+import sassdocExtras from 'sassdoc-extras';
+import swig from './swig';
+
+const copy = denodeify(fse.copy, Promise);
+const renderFile = denodeify(swig.renderFile, Promise);
+const writeFile = denodeify(fs.writeFile, Promise);
+
+const applyDefaults = ctx =>
+  extend({}, def, ctx, {
+    groups: extend(def.groups, ctx.groups),
+    display: extend(def.display, ctx.display),
+  });
+
+const shortcutIcon = (dest, ctx) => {
+  if (!ctx.shortcutIcon) {
+    ctx.shortcutIcon = { type: 'internal', url: 'assets/images/favicon.png' };
+  } else if (ctx.shortcutIcon.type === 'internal') {
+    ctx.shortcutIcon.url = 'assets/images/' + ctx.shortcutIcon.url;
+
+    return () =>
+      copy(ctx.shortcutIcon.path, path.resolve(dest, ctx.shortcutIcon.url));
+  }
+};
+
+export default (dest, ctx) => {
+  ctx = applyDefaults(ctx);
+
+  sassdocExtras.markdown(ctx);
+  sassdocExtras.display(ctx);
+  sassdocExtras.groupName(ctx);
+  sassdocExtras.shortcutIcon(ctx);
+
+  ctx.data.byGroupAndType = sassdocExtras.byGroupAndType(ctx.data);
+
+  const index = path.resolve(__dirname, '../views/documentation/index.html.swig');
+
+  return Promise.all([
+    copy(path.resolve(__dirname, '../assets'), path.resolve(dest, 'assets'))
+      .then(shortcutIcon(dest, ctx)),
+
+    renderFile(index, ctx)
+      .then(html => minify(html, { collapseWhitespace: true }))
+      .then(html => writeFile(path.resolve(dest, 'index.html'), html)),
+  ]);
+};

src/index.js

@@ -0,0 +1,63 @@
+import assert from 'assert';
+import chroma from 'chroma-js';
+import { Swig } from 'swig';
+import swigExtras from 'swig-extras';
+import swigFilters from 'swig/lib/filters';
+
+const swig = new Swig();
+export default swig;
+
+swigExtras.useFilter(swig, 'split');
+swigExtras.useFilter(swig, 'trim');
+swigExtras.useFilter(swig, 'groupby');
+
+const safe = fn =>
+  fn.safe = true && fn;
+
+const isColor = value => {
+  try {
+    chroma(value);
+    return true;
+  } catch (e) {
+    return false;
+  }
+};
+
+const displayAsType = input =>
+  input.split('|')
+    .map(x => x.trim())
+    .map(swigFilters.capitalize)
+    .join('</code> or <code>');
+
+const yiq = ([red, green, blue]) =>
+  ((red * 299) + (green * 587) + (blue * 114)) / 1000;
+
+const yiqContrast = rgb =>
+  (yiq(rgb) >= 128) ? '#000' : '#fff';
+
+const getChannel = (start, hex) =>
+  parseInt(hex.substr(start, 2), 16);
+
+const hexTorgb = hex =>
+  [0, 2, 4].map(x => getChannel(x, hex));
+
+const colorToHex = color =>
+  chroma(color).hex().substr(1);
+
+/**
+ * Normalises a CSS color, then uses the YIQ algorithm to get the
+ * correct contrast.
+ *
+ * @param {String} color
+ * @return {String} `#000` or `#fff` depending on which one is a better.
+ * @see {@link http://stackoverflow.com/questions/11867545/change-text-color-based-on-brightness-of-the-covered-background-area}
+ */
+const maybeYiqContrast = color =>
+  isColor(color) ?
+    yiqContrast(hexToRgb(colorToHex(color))) :
+    '#000';
+
+swig.setFilter('in', (key, object) => key in object);
+swig.setFilter('is_color', isColor);
+swig.setFilter('display_as_type', safe(displayAsType));
+swig.setFilter('yiq', maybeYiqContrast);

src/swig.js

@@ -32,7 +32,7 @@
 
       {% if display.watermark %}
         <a class="footer__watermark" href="http://sassdoc.com">
-          <img src="{{ base }}/assets/images/logo_light_inline.svg" alt="SassDoc Logo" />
+          <img src="assets/images/logo_light_inline.svg" alt="SassDoc Logo" />
         </a>
       {% endif %}
     </div>

views/includes/partials/footer.html.swig

@@ -1,14 +1,10 @@
 <meta charset="utf-8" />
 
 <title>{{ project_title }}{% if package.version %} - v{{ package.version }}{% endif %}</title>
-<link rel="stylesheet" href="{{ base }}/assets/css/main.css" />
+<link rel="stylesheet" href="assets/css/main.css" />
 <link href='http://fonts.googleapis.com/css?family=Open+Sans:400,500,700' rel='stylesheet' type='text/css'>
 <meta name="viewport" content="width=device-width">
 <meta content="IE=edge, chrome=1" http-equiv="X-UA-Compatible">
 
 <!-- Thanks to Sass-lang.com for the icons -->
-{% if shortcutIcon.type == 'internal' %}
-<link href="{{ base }}/{{ shortcutIcon.url }}" rel="shortcut icon">
-{% else %}
 <link href="{{ shortcutIcon.url }}" rel="shortcut icon">
-{% endif %}