aboutsummaryrefslogtreecommitdiffstats
path: root/development/tools
diff options
context:
space:
mode:
authorDan Finlay <dan@danfinlay.com>2018-04-13 05:39:28 +0800
committerDan Finlay <dan@danfinlay.com>2018-04-13 05:46:05 +0800
commit136caa2034e151763347d20488f2516277631bc9 (patch)
tree0b8d09b0f9003092611b37acf48ffc67e718cbd8 /development/tools
parent29dab1e9e00c1c1e6ad834026df51b2839d3171d (diff)
downloadtangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.gz
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.bz2
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.lz
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.xz
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.tar.zst
tangerine-wallet-browser-136caa2034e151763347d20488f2516277631bc9.zip
Add JSDocs Page and Script
Includes new script `npm run doc` for generating docs page.
Diffstat (limited to 'development/tools')
-rw-r--r--development/tools/.jsdoc.json25
-rw-r--r--development/tools/README.md15
-rw-r--r--development/tools/appveyor.txt21
3 files changed, 61 insertions, 0 deletions
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