Initial commit.

Author: neogeek

.eslintrc

@@ -0,0 +1,10 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards"
+  ],
+  "rules": {
+    "new-cap": 0,
+    "no-shadow": 0,
+    "no-sync": 0
+  }
+}

.gitignore

@@ -0,0 +1 @@
+node_modules/

.npmignore

@@ -0,0 +1,3 @@
+.eslintrc
+
+Makefile

.travis.yml

@@ -0,0 +1,12 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+  - "6"
+  - "7"
+before_install:
+  - if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
+  - npm install doxdox -g
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+sudo: false

DOCUMENTATION.md

@@ -0,0 +1,40 @@
+# [doxdox-plugin-dash](https://github.com/neogeek/doxdox-plugin-dash) *1.0.0*
+
+> Dash export plugin for doxdox.
+
+
+### index.js
+
+
+#### plugin(data) 
+
+Dash export plugin for doxdox.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| data | `Array`  | Methods parsed using a doxdox parser. |   |
+
+
+
+
+##### Examples
+
+```javascript
+parseInputs(inputs, {'parser': 'dox', 'layout': 'dash'}).then(content => console.log(content));
+```
+
+
+##### Returns
+
+
+- `Promise`  Promise with generated content.
+
+
+
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Doxey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,12 @@
+BIN=node_modules/.bin
+
+test:
+	make lint
+	doxdox index.js --layout markdown | diff DOCUMENTATION.md -
+
+lint:
+	$(BIN)/eslint index.js
+	$(BIN)/eslint helpers.js
+
+docs:
+	doxdox index.js --layout markdown --output DOCUMENTATION.md

README.md

@@ -0,0 +1,19 @@
+# doxdox-plugin-dash
+
+> Dash export plugin for doxdox.
+
+[![Build Status](https://travis-ci.org/neogeek/doxdox-plugin-dash.svg?branch=master)](https://travis-ci.org/neogeek/doxdox-plugin-dash)
+[![NPM Version](http://img.shields.io/npm/v/doxdox-plugin-dash.svg?style=flat)](https://www.npmjs.org/package/doxdox-plugin-dash)
+[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/neogeek/doxdox-plugin-dash)
+
+## Install
+
+```bash
+$ npm install doxdox doxdox-plugin-dash --save-dev
+```
+
+## Usage
+
+```bash
+$ doxdox 'src/**/*.js' --layout dash --output docs.zip
+```

helpers.js

@@ -0,0 +1,36 @@
+const Handlebars = require('handlebars');
+
+const hljs = require('highlight.js');
+const markdown = require('markdown-it')({
+    highlight (code) {
+
+        return hljs.highlight('javascript', code).value;
+
+    },
+    'html': true,
+    'linkify': true
+});
+
+Handlebars.registerHelper('highlightBlock', block => {
+
+    if (block) {
+
+        return hljs.highlight('javascript', block).value;
+
+    }
+
+    return null;
+
+});
+
+Handlebars.registerHelper('markdown', block => {
+
+    if (block) {
+
+        return markdown.render(block);
+
+    }
+
+    return null;
+
+});

index.js

@@ -0,0 +1,141 @@
+const fs = require('fs');
+const path = require('path');
+
+const Handlebars = require('handlebars');
+
+require('./helpers');
+
+const admzip = require('adm-zip');
+const temp = require('temp').track();
+const sqlite3 = require('sqlite3').verbose();
+
+/**
+ * Dash export plugin for doxdox.
+ *
+ * @example parseInputs(inputs, {'parser': 'dox', 'layout': 'dash'}).then(content => console.log(content));
+ * @param {Array} data Methods parsed using a doxdox parser.
+ * @return {Promise} Promise with generated content.
+ * @public
+ */
+
+const plugin = data => new Promise((resolve, reject) => {
+
+    const zip = new admzip();
+    const tempdb = temp.openSync('temp.sqlite');
+    const db = new sqlite3.Database(tempdb.path);
+
+    fs.readFile(path.join(__dirname, 'templates/method.hbs'), 'utf8', (err, contents) => {
+
+        if (err) {
+
+            return reject(err);
+
+        }
+
+        const methodTemplate = Handlebars.compile(contents);
+
+        fs.readFile(path.join(__dirname, 'templates/Info.plist.hbs'), 'utf8', (err, contents) => {
+
+            if (err) {
+
+                return reject(err);
+
+            }
+
+            const plistTemplate = Handlebars.compile(contents);
+
+            zip.addFile(
+                `${data.title}.docset/Contents/Info.plist`,
+                plistTemplate(data)
+            );
+
+            zip.addLocalFile(
+                path.join(__dirname, 'templates/resources/bootstrap.min.css'),
+                `${data.title}.docset/Contents/Resources/Documents/resources/`
+            );
+
+            zip.addLocalFile(
+                path.join(__dirname, 'templates/resources/github.min.css'),
+                `${data.title}.docset/Contents/Resources/Documents/resources/`
+            );
+
+            db.serialize(() => {
+
+                db.run('CREATE TABLE searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);');
+                db.run('CREATE UNIQUE INDEX anchor ON searchIndex (name, type, path);');
+
+                data.files.forEach(file => {
+
+                    file.methods.forEach(method => {
+
+                        zip.addFile(
+                            `${data.title}.docset/Contents/Resources/Documents/${method.uid}.html`,
+                            methodTemplate(method)
+                        );
+
+                        db.run('INSERT OR IGNORE INTO searchIndex(name, type, path) VALUES ($name, $type, $path);', {
+                            '$name': method.name,
+                            '$path': `${method.uid}.html`,
+                            '$type': method.type.replace(/^[a-z]/, match => match.toUpperCase())
+                        });
+
+                        if (method.tags.property) {
+
+                            method.tags.property.forEach(property => {
+
+                                db.run('INSERT OR IGNORE INTO searchIndex(name, type, path) VALUES ($name, $type, $path);', {
+                                    '$name': `${method.name}.${property.name}`,
+                                    '$path': `${method.uid}.html#//apple_ref/cpp/Property/${property.name}`,
+                                    '$type': 'Property'
+                                });
+
+                            });
+
+                        }
+
+                    });
+
+                });
+
+            });
+
+            db.close(err => {
+
+                if (err) {
+
+                    return reject(err);
+
+                }
+
+                fs.readFile(tempdb.path, (err, contents) => {
+
+                    if (err) {
+
+                        return reject(err);
+
+                    }
+
+                    zip.addFile(
+                        `${data.title}.docset/Contents/Resources/docSet.dsidx`,
+                        contents
+                    );
+
+                    return resolve(zip.toBuffer());
+
+                });
+
+                return false;
+
+            });
+
+            return false;
+
+        });
+
+        return false;
+
+    });
+
+});
+
+module.exports = plugin;