From 136caa2034e151763347d20488f2516277631bc9 Mon Sep 17 00:00:00 2001
From: Dan Finlay <dan@danfinlay.com>
Date: Thu, 12 Apr 2018 14:39:28 -0700
Subject: Add JSDocs Page and Script

Includes new script `npm run doc` for generating docs page.
---
 development/tools/.jsdoc.json  | 25 +++++++++++++++++++++++++
 development/tools/README.md    | 15 +++++++++++++++
 development/tools/appveyor.txt | 21 +++++++++++++++++++++
 3 files changed, 61 insertions(+)
 create mode 100644 development/tools/.jsdoc.json
 create mode 100644 development/tools/README.md
 create mode 100644 development/tools/appveyor.txt

(limited to 'development')

diff --git a/development/tools/.jsdoc.json b/development/tools/.jsdoc.json
new file mode 100644
index 000000000..fd90bf89f
--- /dev/null
+++ b/development/tools/.jsdoc.json
@@ -0,0 +1,25 @@
+{
+    "tags": {
+        "allowUnknownTags": false
+    },
+    "source": {
+        "include": "app/scripts/",
+        "includePattern": ".js$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "opts": {
+        "template": "node_modules/radgrad-jsdoc-template/",
+        "encoding": "utf8",
+        "destination": "docs/jsdocs",
+        "recurse": true,
+        "verbose": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}
+
diff --git a/development/tools/README.md b/development/tools/README.md
new file mode 100644
index 000000000..caef51fe6
--- /dev/null
+++ b/development/tools/README.md
@@ -0,0 +1,15 @@
+# Development Tools & Configurations
+
+This folder contains configuration files which are used by the the different
+development-tools, like e.g. JsDoc.
+
+
+## Appveyor
+
+
+https://www.appveyor.com/docs/build-configuration/#alternative-yaml-file-location
+
+Withtin the configuration, point to a weblocation of a txt config file:
+
+https://ci.appveyor.com/project/lazaridiscom/mm-vault/settings
+https://raw.githubusercontent.com/lazaridiscom/mm-vault/master/dev/tools/appveyor.txt
diff --git a/development/tools/appveyor.txt b/development/tools/appveyor.txt
new file mode 100644
index 000000000..4ed974079
--- /dev/null
+++ b/development/tools/appveyor.txt
@@ -0,0 +1,21 @@
+# Test against the latest version of this Node.js version
+environment:
+  nodejs_version: "8"
+
+# Install scripts. (runs after repo cloning)
+install:
+  # Get the latest stable version of Node.js or io.js
+  - ps: Install-Product node $env:nodejs_version
+  # install modules
+  - npm install
+
+# Post-install test scripts.
+test_script:
+  # Output useful info for debugging.
+  - node --version
+  - npm --version
+  # run tests
+  - npm test
+
+# Don't actually build.
+build: off
-- 
cgit v1.2.3