Initial commit.

Author: neogeek

.bithoundrc

@@ -0,0 +1,8 @@
+{
+  "ignore": [
+    "**/test/**"
+  ],
+  "test": [
+    "**/test/**"
+  ]
+}

.eslintrc

@@ -0,0 +1,9 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards"
+  ],
+  "rules": {
+    "no-shadow": 0,
+    "sort-keys": 0
+  }
+}

.gitignore

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

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,11 @@
+BIN=node_modules/.bin
+
+test:
+	make lint
+	$(BIN)/mocha test/specs/**.js
+
+lint:
+	$(BIN)/eslint index.js
+	$(BIN)/eslint test/specs/
+
+.PHONY: test

README.md

@@ -0,0 +1,12 @@
+# doxdox-parser-dox
+
+> Dox parser plugin for doxdox.
+
+[![NPM Version](http://img.shields.io/npm/v/doxdox-parser-dox.svg?style=flat)](https://www.npmjs.org/package/doxdox-parser-dox)
+![](https://img.shields.io/badge/requires%20doxdox-v1.0.0-orange.svg)
+
+## Install
+
+```bash
+$ npm install doxdox doxdox-parser-dox --save-dev
+```

index.js

@@ -0,0 +1,89 @@
+const dox = require('dox');
+
+const formatStringForName = content =>
+    content.toString()
+        .replace(/\.prototype|\(\)/g, '');
+
+const formatStringForUID = content =>
+    content.toString()
+        .toLowerCase()
+        .replace(/[^\w\.]+/g, '-')
+        .replace(/^-|-$/g, '');
+
+const parser = (content, filename) => dox.parseComments(content, {'raw': true}).reduce((prev, curr) => {
+
+    if (!curr.ignore && curr.ctx) {
+
+        prev.push({
+            'uid': formatStringForUID(`${filename}-${curr.ctx.string}`),
+            'isPrivate': curr.isPrivate,
+            'type': curr.ctx.type,
+            'name': formatStringForName(curr.ctx.string),
+            'description': curr.description.full,
+            'params': curr.tags.filter(tag => tag.type === 'param' && !tag.name.match(/\./))
+                .reduce((prev, curr) => {
+
+                    if (prev) {
+
+                        return `${prev}, ${curr.name.replace(/\[|\]/g, '')}`;
+
+                    }
+
+                    return `${curr.name.replace(/\[|\]/g, '')}`;
+
+                }, ''),
+            'tags': {
+                'example': curr.tags.filter(tag => tag.type === 'example')
+                    .reduce((prev, curr) => {
+
+                        prev.push(curr.string);
+
+                        return prev;
+
+                    }, []),
+                'param': curr.tags.filter(tag => tag.type === 'param')
+                    .reduce((prev, curr) => {
+
+                        prev.push({
+                            'name': curr.name.replace(/\[|\]/g, ''),
+                            'isOptional': curr.optional,
+                            'types': curr.types,
+                            'description': curr.description
+                        });
+
+                        return prev;
+
+                    }, []),
+                'property': curr.tags.filter(tag => tag.type === 'property')
+                    .reduce((prev, curr) => {
+
+                        prev.push({
+                            'name': curr.name,
+                            'types': curr.types,
+                            'description': curr.description
+                        });
+
+                        return prev;
+
+                    }, []),
+                'return': curr.tags.filter(tag => tag.type === 'return' || tag.type === 'returns')
+                    .reduce((prev, curr) => {
+
+                        prev.push({
+                            'types': curr.types,
+                            'description': curr.description
+                        });
+
+                        return prev;
+
+                    }, [])
+            }
+        });
+
+    }
+
+    return prev;
+
+}, []);
+
+module.exports = parser;

package.json

@@ -0,0 +1,35 @@
+{
+  "name": "doxdox-parser-dox",
+  "description": "Dox parser plugin for doxdox.",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "dox": "0.9.0"
+  },
+  "devDependencies": {
+    "@neogeek/eslint-config-standards": "1.6.3",
+    "eslint": "3.8.0",
+    "mocha": "3.1.2"
+  },
+  "scripts": {
+    "test": "make test"
+  },
+  "keywords": [
+    "doxdox",
+    "parser",
+    "dox"
+  ],
+  "authors": [
+    {
+      "name": "Scott Doxey",
+      "email": "[email protected]",
+      "homepage": "http://scottdoxey.com/"
+    }
+  ],
+  "homepage": "https://github.com/neogeek/doxdox-parser-dox",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/neogeek/doxdox-parser-dox.git"
+  }
+}

test/.eslintignore

@@ -0,0 +1 @@
+fixtures/

test/.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards/.eslintrc-tests"
+  ]
+}