From df21addf79f7146f2400c210cdb4e12d19cc7702 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Moreau?= <cem.moreau@gmail.com>
Date: Thu, 7 Jun 2018 16:43:23 +0200
Subject: [PATCH] [enh] typedoc documentation
---
.gitignore | 3 ++
package.json | 3 ++
yarn.lock | 127 ++++++++++++++++++++++++++++++++++++++++++++++++++-
3 files changed, 132 insertions(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 9cf17be13..6dd12606b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -35,6 +35,9 @@ vagrant/duniter
.nyc_output
coverage/
+# typecode
+typedoc/
+
/index.js*
/index.d.ts
/server.js*
diff --git a/package.json b/package.json
index f559351fc..5a0d2c664 100644
--- a/package.json
+++ b/package.json
@@ -25,6 +25,7 @@
"prepublish": "tsc",
"tsc": "tsc",
"tscw": "tsc -w",
+ "doc": "typedoc --out typedoc/ index.ts app/ --mode file --includeDeclarations --sourcefile-url-prefix \"https://git.duniter.org/nodes/typescript/duniter/tree/$(git rev-parse --abbrev-ref HEAD)/\"",
"test": "nyc --reporter html mocha",
"start": "node bin/duniter start",
"build": "tsc && cd \"node_modules/duniter-ui\" && npm install && npm run build",
@@ -96,6 +97,7 @@
"sqlite3": "3.1.13",
"tail": "^1.2.1",
"tweetnacl": "0.14.3",
+ "typedoc": "^0.11.1",
"underscore": "1.8.3",
"unzip": "0.1.11",
"unzip2": "0.2.5",
@@ -120,6 +122,7 @@
"supertest": "",
"tmp": "0.0.29",
"ts-node": "^3.3.0",
+ "typedoc-plugin-sourcefile-url": "^1.0.3",
"typescript": "^2.8.1"
},
"peerDependencies": {},
diff --git a/yarn.lock b/yarn.lock
index ee9288bed..6b548878e 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -2,18 +2,67 @@
# yarn lockfile v1
+"@types/events@*":
+ version "1.2.0"
+ resolved "https://registry.yarnpkg.com/@types/events/-/events-1.2.0.tgz#81a6731ce4df43619e5c8c945383b3e62a89ea86"
+
+"@types/fs-extra@5.0.1":
+ version "5.0.1"
+ resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-5.0.1.tgz#cd856fbbdd6af2c11f26f8928fd8644c9e9616c9"
+ dependencies:
+ "@types/node" "*"
+
+"@types/glob@*":
+ version "5.0.35"
+ resolved "https://registry.yarnpkg.com/@types/glob/-/glob-5.0.35.tgz#1ae151c802cece940443b5ac246925c85189f32a"
+ dependencies:
+ "@types/events" "*"
+ "@types/minimatch" "*"
+ "@types/node" "*"
+
+"@types/handlebars@4.0.36":
+ version "4.0.36"
+ resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.36.tgz#ff57c77fa1ab6713bb446534ddc4d979707a3a79"
+
+"@types/highlight.js@9.12.2":
+ version "9.12.2"
+ resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.2.tgz#6ee7cd395effe5ec80b515d3ff1699068cd0cd1d"
+
+"@types/lodash@4.14.104":
+ version "4.14.104"
+ resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.104.tgz#53ee2357fa2e6e68379341d92eb2ecea4b11bb80"
+
"@types/lokijs@^1.5.2":
version "1.5.2"
resolved "https://registry.yarnpkg.com/@types/lokijs/-/lokijs-1.5.2.tgz#ed228f080033ce1fb16eff4acde65cb9ae0f1bf2"
+"@types/marked@0.3.0":
+ version "0.3.0"
+ resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.3.0.tgz#583c223dd33385a1dda01aaf77b0cd0411c4b524"
+
+"@types/minimatch@*", "@types/minimatch@3.0.3":
+ version "3.0.3"
+ resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
+
"@types/mocha@^2.2.41":
version "2.2.44"
resolved "https://registry.yarnpkg.com/@types/mocha/-/mocha-2.2.44.tgz#1d4a798e53f35212fd5ad4d04050620171cd5b5e"
+"@types/node@*":
+ version "10.3.1"
+ resolved "https://registry.yarnpkg.com/@types/node/-/node-10.3.1.tgz#51092fbacaed768a122a293814474fbf6e5e8b6d"
+
"@types/node@^8.0.9":
version "8.0.53"
resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.53.tgz#396b35af826fa66aad472c8cb7b8d5e277f4e6d8"
+"@types/shelljs@0.7.8":
+ version "0.7.8"
+ resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.8.tgz#4b4d6ee7926e58d7bca448a50ba442fd9f6715bd"
+ dependencies:
+ "@types/glob" "*"
+ "@types/node" "*"
+
"@types/should@^8.3.0":
version "8.3.0"
resolved "https://registry.yarnpkg.com/@types/should/-/should-8.3.0.tgz#e2b460243685dbe377182f39ef38d37f4d157ada"
@@ -1533,6 +1582,14 @@ fs-extra@^0.22.1:
jsonfile "^2.1.0"
rimraf "^2.2.8"
+fs-extra@^5.0.0:
+ version "5.0.0"
+ resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-5.0.0.tgz#414d0110cdd06705734d055652c5411260c31abd"
+ dependencies:
+ graceful-fs "^4.1.2"
+ jsonfile "^4.0.0"
+ universalify "^0.1.0"
+
fs.realpath@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
@@ -1692,7 +1749,7 @@ growl@1.9.2:
version "1.9.2"
resolved "https://registry.yarnpkg.com/growl/-/growl-1.9.2.tgz#0ea7743715db8d8de2c5ede1775e1b45ac85c02f"
-handlebars@^4.0.3:
+handlebars@^4.0.3, handlebars@^4.0.6:
version "4.0.11"
resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.0.11.tgz#630a35dfe0294bc281edae6ffc5d329fc7982dcc"
dependencies:
@@ -1783,6 +1840,10 @@ he@1.1.1:
version "1.1.1"
resolved "https://registry.yarnpkg.com/he/-/he-1.1.1.tgz#93410fd21b009735151f8868c2f271f3427e23fd"
+highlight.js@^9.0.0:
+ version "9.12.0"
+ resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.12.0.tgz#e6d9dbe57cbefe60751f02af336195870c90c01e"
+
hoek@0.9.x:
version "0.9.1"
resolved "https://registry.yarnpkg.com/hoek/-/hoek-0.9.1.tgz#3d322462badf07716ea7eb85baf88079cddce505"
@@ -2215,6 +2276,12 @@ jsonfile@^2.1.0:
optionalDependencies:
graceful-fs "^4.1.6"
+jsonfile@^4.0.0:
+ version "4.0.0"
+ resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb"
+ optionalDependencies:
+ graceful-fs "^4.1.6"
+
jsonify@~0.0.0:
version "0.0.0"
resolved "https://registry.yarnpkg.com/jsonify/-/jsonify-0.0.0.tgz#2c74b6ee41d93ca51b7b5aaee8f503631d252a73"
@@ -2373,6 +2440,10 @@ lodash@^4.0.0, lodash@^4.13.1, lodash@^4.14.0, lodash@^4.17.4, lodash@^4.3.0, lo
version "4.17.4"
resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.4.tgz#78203a4d1c328ae1d86dca6460e369b57f4055ae"
+lodash@^4.17.5:
+ version "4.17.10"
+ resolved "https://registry.yarnpkg.com/lodash/-/lodash-4.17.10.tgz#1b7793cf7259ea38fb3661d4d38b3260af8ae4e7"
+
log-driver@1.2.4:
version "1.2.4"
resolved "https://registry.yarnpkg.com/log-driver/-/log-driver-1.2.4.tgz#2d62d7faef45d8a71341961a04b0761eca99cfa3"
@@ -2406,6 +2477,10 @@ map-stream@~0.1.0:
version "0.1.0"
resolved "https://registry.yarnpkg.com/map-stream/-/map-stream-0.1.0.tgz#e56aa94c4c8055a16404a0674b78f215f7c8e194"
+marked@^0.3.17:
+ version "0.3.19"
+ resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.19.tgz#5d47f709c4c9fc3c216b6d46127280f40b39d790"
+
"match-stream@>= 0.0.2 < 1", match-stream@~0.0.2:
version "0.0.2"
resolved "https://registry.yarnpkg.com/match-stream/-/match-stream-0.0.2.tgz#99eb050093b34dffade421b9ac0b410a9cfa17cf"
@@ -3049,6 +3124,10 @@ progress@^1.1.8:
version "1.1.8"
resolved "https://registry.yarnpkg.com/progress/-/progress-1.1.8.tgz#e260c78f6161cdd9b0e56cc3e0a85de17c7a57be"
+progress@^2.0.0:
+ version "2.0.0"
+ resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.0.tgz#8a1be366bf8fc23db2bd23f10c6fe920b4389d1f"
+
proxy-addr@~1.1.3:
version "1.1.5"
resolved "https://registry.yarnpkg.com/proxy-addr/-/proxy-addr-1.1.5.tgz#71c0ee3b102de3f202f3b64f608d173fcba1a918"
@@ -3528,6 +3607,14 @@ shelljs@^0.7.5:
interpret "^1.0.0"
rechoir "^0.6.2"
+shelljs@^0.8.1:
+ version "0.8.2"
+ resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.2.tgz#345b7df7763f4c2340d584abb532c5f752ca9e35"
+ dependencies:
+ glob "^7.0.0"
+ interpret "^1.0.0"
+ rechoir "^0.6.2"
+
should-equal@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3"
@@ -4033,6 +4120,40 @@ typedarray@^0.0.6:
version "0.0.6"
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
+typedoc-default-themes@^0.5.0:
+ version "0.5.0"
+ resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"
+
+typedoc-plugin-sourcefile-url@^1.0.3:
+ version "1.0.3"
+ resolved "https://registry.yarnpkg.com/typedoc-plugin-sourcefile-url/-/typedoc-plugin-sourcefile-url-1.0.3.tgz#fbbcc4b71bd92d2f794d1c169a480042296b1fe6"
+
+typedoc@^0.11.1:
+ version "0.11.1"
+ resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.11.1.tgz#9f033887fd2218c769e1045feb88a1efed9f12c9"
+ dependencies:
+ "@types/fs-extra" "5.0.1"
+ "@types/handlebars" "4.0.36"
+ "@types/highlight.js" "9.12.2"
+ "@types/lodash" "4.14.104"
+ "@types/marked" "0.3.0"
+ "@types/minimatch" "3.0.3"
+ "@types/shelljs" "0.7.8"
+ fs-extra "^5.0.0"
+ handlebars "^4.0.6"
+ highlight.js "^9.0.0"
+ lodash "^4.17.5"
+ marked "^0.3.17"
+ minimatch "^3.0.0"
+ progress "^2.0.0"
+ shelljs "^0.8.1"
+ typedoc-default-themes "^0.5.0"
+ typescript "2.7.2"
+
+typescript@2.7.2:
+ version "2.7.2"
+ resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.7.2.tgz#2d615a1ef4aee4f574425cdff7026edf81919836"
+
typescript@^2.8.1:
version "2.8.1"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.8.1.tgz#6160e4f8f195d5ba81d4876f9c0cc1fbc0820624"
@@ -4078,6 +4199,10 @@ underscore@~1.7.0:
version "1.7.0"
resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.7.0.tgz#6bbaf0877500d36be34ecaa584e0db9fef035209"
+universalify@^0.1.0:
+ version "0.1.1"
+ resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.1.tgz#fa71badd4437af4c148841e3b3b165f9e9e590b7"
+
unpipe@1.0.0, unpipe@~1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec"
--
GitLab