diff --git a/.gitignore b/.gitignore index 07f8c08f90df7..af8b3ba51c2fc 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ examples/*/webpack.config.js package-backup.json .history .Trash-* +packages/plugin/typedoc diff --git a/configs/typedoc-tsconfig.json b/configs/typedoc-tsconfig.json new file mode 100644 index 0000000000000..802f19c4b6c91 --- /dev/null +++ b/configs/typedoc-tsconfig.json @@ -0,0 +1,9 @@ +// This file could be removed when +// https://github.com/TypeStrong/typedoc/issues/844 +// will be integrated in a new typedocs release (should be 0.14.0) +{ + "extends": "./base.tsconfig", + "compilerOptions": { + "declarationMap": false + } +} diff --git a/configs/typedoc.json b/configs/typedoc.json index becd0060858ab..5f7b62a0f8e64 100644 --- a/configs/typedoc.json +++ b/configs/typedoc.json @@ -2,5 +2,6 @@ "ignoreCompilerErrors": true, "mode": "file", "out": "docs/api", - "excludeExternals": true -} \ No newline at end of file + "excludeExternals": true, + "includeDeclarations": true +} diff --git a/dev-packages/ext-scripts/package.json b/dev-packages/ext-scripts/package.json index 9d16c2a58eb97..853696e758650 100644 --- a/dev-packages/ext-scripts/package.json +++ b/dev-packages/ext-scripts/package.json @@ -23,7 +23,7 @@ "ext:compile:clean": "rimraf lib", "ext:lint": "tslint -c ../../configs/build.tslint.json --project compile.tsconfig.json", "ext:watch": "tsc -w -p compile.tsconfig.json", - "ext:docs": "typedoc --tsconfig compile.tsconfig.json --options ../../configs/typedoc.json", + "ext:docs": "typedoc --tsconfig ../../configs/typedoc-tsconfig.json --options ../../configs/typedoc.json src", "ext:docs:clean": "rimraf docs/api", "ext:test": "nyc mocha --opts ../../configs/mocha.opts \"./src/**/*.*spec.ts\"", "ext:test:watch": "mocha -w --opts ../../configs/mocha.opts \"./src/**/*.*spec.ts\"", diff --git a/package.json b/package.json index b0aaba2f81b25..43ca86e32cc84 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,7 @@ "ts-node": "<7.0.0", "tslint": "^5.10.0", "tslint-language-service": "^0.9.9", - "typedoc": "^0.8", + "typedoc": "^0.13.0", "typescript": "^3.1.3", "uuid": "^3.1.0", "wdio-mocha-framework": "0.5.9", diff --git a/packages/plugin/package.json b/packages/plugin/package.json index 77624912c472e..622bb5ce7a41f 100644 --- a/packages/plugin/package.json +++ b/packages/plugin/package.json @@ -24,7 +24,7 @@ "build": "theiaext build", "watch": "theiaext watch", "test": "theiaext test", - "docs": "theiaext docs" + "docs": "rimraf docs && typedoc --module commonjs --target es6 --mode file --hideGenerator --name 'Theia Plug-in API' --readme API.md --excludeExternals --includeDeclarations --out ./docs/api src/theia.d.ts" }, "devDependencies": { "@theia/ext-scripts": "^0.3.16" diff --git a/yarn.lock b/yarn.lock index 209e629f20357..39ba42b850c1c 100644 --- a/yarn.lock +++ b/yarn.lock @@ -206,12 +206,19 @@ dependencies: "@types/node" "*" -"@types/fs-extra@^4.0.0", "@types/fs-extra@^4.0.2": +"@types/fs-extra@^4.0.2": version "4.0.8" resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-4.0.8.tgz#6957ddaf9173195199cb96da3db44c74700463d2" dependencies: "@types/node" "*" +"@types/fs-extra@^5.0.3": + version "5.0.4" + resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-5.0.4.tgz#b971134d162cc0497d221adde3dbb67502225599" + integrity sha512-DsknoBvD8s+RFfSGjmERJ7ZOP1HI0UZRA3FSI+Zakhrc/Gy26YQsLI+m5V5DHxroHRJqCDLKJp7Hixn8zyaF7g== + dependencies: + "@types/node" "*" + "@types/glob@*", "@types/glob@^5.0.30": version "5.0.35" resolved "https://registry.yarnpkg.com/@types/glob/-/glob-5.0.35.tgz#1ae151c802cece940443b5ac246925c85189f32a" @@ -220,13 +227,15 @@ "@types/minimatch" "*" "@types/node" "*" -"@types/handlebars@^4.0.31": +"@types/handlebars@^4.0.38": version "4.0.39" resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.0.39.tgz#961fb54db68030890942e6aeffe9f93a957807bd" + integrity sha512-vjaS7Q0dVqFp85QhyPSZqDKnTTCemcSHNHFvDdalO1s0Ifz5KuE64jQD5xoUkfdWwF4WpqdJEl7LsWH8rzhKJA== -"@types/highlight.js@^9.1.8", "@types/highlight.js@^9.12.2": +"@types/highlight.js@^9.12.2", "@types/highlight.js@^9.12.3": version "9.12.3" resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.3.tgz#b672cfaac25cbbc634a0fd92c515f66faa18dbca" + integrity sha512-pGF/zvYOACZ/gLGWdQH8zSwteQS1epp68yRcVLJMgUck/MjEn/FBYmPub9pXT8C1e4a8YZfHo1CKyV8q1vKUnQ== "@types/jsdom@^11.0.4": version "11.0.6" @@ -255,10 +264,15 @@ dependencies: "@types/lodash" "*" -"@types/lodash@*", "@types/lodash@^4.14.37": +"@types/lodash@*": version "4.14.116" resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.116.tgz#5ccf215653e3e8c786a58390751033a9adca0eb9" +"@types/lodash@^4.14.110": + version "4.14.118" + resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.118.tgz#247bab39bfcc6d910d4927c6e06cbc70ec376f27" + integrity sha512-iiJbKLZbhSa6FYRip/9ZDX6HXhayXLDGY2Fqws9cOkEQ6XeKfaxB0sC541mowZJueYyMnVUmmG+al5/4fCDrgw== + "@types/markdown-it-anchor@^4.0.1": version "4.0.1" resolved "https://registry.yarnpkg.com/@types/markdown-it-anchor/-/markdown-it-anchor-4.0.1.tgz#f9607c56aaf608fcec26f7de0c4846e1baf80e68" @@ -273,9 +287,10 @@ version "0.0.4" resolved "https://registry.yarnpkg.com/@types/markdown-it/-/markdown-it-0.0.4.tgz#c5f67365916044b342dae8d702724788ba0b5b74" -"@types/marked@0.0.28": - version "0.0.28" - resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.0.28.tgz#44ba754e9fa51432583e8eb30a7c4dd249b52faa" +"@types/marked@^0.4.0": + version "0.4.2" + resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.4.2.tgz#64a89e53ea37f61cc0f3ee1732c555c2dbf6452f" + integrity sha512-cDB930/7MbzaGF6U3IwSQp6XBru8xWajF5PV2YZZeV8DyiliTuld11afVztGI9+yJZ29il5E+NpGA6ooV/Cjkg== "@types/mime-types@^2.1.0": version "2.1.0" @@ -285,13 +300,10 @@ version "2.0.0" resolved "https://registry.yarnpkg.com/@types/mime/-/mime-2.0.0.tgz#5a7306e367c539b9f6543499de8dd519fac37a8b" -"@types/minimatch@*": +"@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/minimatch@^2.0.29": - version "2.0.29" - resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-2.0.29.tgz#5002e14f75e2d71e564281df0431c8c1b4a2a36a" + integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA== "@types/mocha@^2.2.41": version "2.2.48" @@ -379,9 +391,10 @@ "@types/express-serve-static-core" "*" "@types/mime" "*" -"@types/shelljs@^0.7.0": - version "0.7.9" - resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.7.9.tgz#3abecb72d9cad9cd4b0e7cb86ed10a97d93ba602" +"@types/shelljs@^0.8.0": + version "0.8.0" + resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.8.0.tgz#0caa56b68baae4f68f44e0dd666ab30b098e3632" + integrity sha512-vs1hCC8RxLHRu2bwumNyYRNrU3o8BtZhLysH5A4I98iYmA2APl6R3uNQb5ihl+WiwH0xdC9LLO+vRrXLs/Kyxg== dependencies: "@types/glob" "*" "@types/node" "*" @@ -4139,7 +4152,7 @@ fs-extra@^3.0.1: jsonfile "^3.0.0" universalify "^0.1.0" -fs-extra@^4.0.0, fs-extra@^4.0.1, fs-extra@^4.0.2: +fs-extra@^4.0.1, fs-extra@^4.0.2: version "4.0.3" resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-4.0.3.tgz#0d852122e5bc5beb453fb028e9c0c9bf36340c94" dependencies: @@ -6148,9 +6161,10 @@ markdown-it@^8.4.0: mdurl "^1.0.1" uc.micro "^1.0.5" -marked@^0.3.5: - version "0.3.19" - resolved "https://registry.yarnpkg.com/marked/-/marked-0.3.19.tgz#5d47f709c4c9fc3c216b6d46127280f40b39d790" +marked@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/marked/-/marked-0.4.0.tgz#9ad2c2a7a1791f10a852e0112f77b571dce10c66" + integrity sha512-tMsdNBgOsrUophCAFQl0XPe6Zqk/uy9gnue+jIIKhykO51hxyu6uNx7zBPy0+y/WKYVZZMspV9YeXLNdKk+iYw== math-expression-evaluator@^1.2.14: version "1.2.17" @@ -8634,17 +8648,10 @@ shebang-regex@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3" -shelljs@^0.7.0: - version "0.7.8" - resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.7.8.tgz#decbcf874b0d1e5fb72e14b164a9683048e9acb3" - dependencies: - glob "^7.0.0" - interpret "^1.0.0" - rechoir "^0.6.2" - -shelljs@^0.8.0: +shelljs@^0.8.0, shelljs@^0.8.2: version "0.8.2" resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.2.tgz#345b7df7763f4c2340d584abb532c5f752ca9e35" + integrity sha512-pRXeNrCA2Wd9itwhvLp5LZQvPJ0wU6bcjaTMywHHGX5XWhVN2nzSu7WV0q+oUY7mGK3mgSkDDzP3MgjqdyIgbQ== dependencies: glob "^7.0.0" interpret "^1.0.0" @@ -9558,27 +9565,28 @@ 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@^0.8: - version "0.8.0" - resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.8.0.tgz#d7172bc6a29964f451b7609c005beadadefe2361" - dependencies: - "@types/fs-extra" "^4.0.0" - "@types/handlebars" "^4.0.31" - "@types/highlight.js" "^9.1.8" - "@types/lodash" "^4.14.37" - "@types/marked" "0.0.28" - "@types/minimatch" "^2.0.29" - "@types/shelljs" "^0.7.0" - fs-extra "^4.0.0" +typedoc@^0.13.0: + version "0.13.0" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.13.0.tgz#9efdf352bd54873955cd161bd4b75f24a8c59dde" + integrity sha512-jQWtvPcV+0fiLZAXFEe70v5gqjDO6pJYJz4mlTtmGJeW2KRoIU/BEfktma6Uj8Xii7UakuZjbxFewl3UYOkU/w== + dependencies: + "@types/fs-extra" "^5.0.3" + "@types/handlebars" "^4.0.38" + "@types/highlight.js" "^9.12.3" + "@types/lodash" "^4.14.110" + "@types/marked" "^0.4.0" + "@types/minimatch" "3.0.3" + "@types/shelljs" "^0.8.0" + fs-extra "^7.0.0" handlebars "^4.0.6" highlight.js "^9.0.0" - lodash "^4.13.1" - marked "^0.3.5" + lodash "^4.17.10" + marked "^0.4.0" minimatch "^3.0.0" progress "^2.0.0" - shelljs "^0.7.0" + shelljs "^0.8.2" typedoc-default-themes "^0.5.0" - typescript "2.4.1" + typescript "3.1.x" typescript-language-server@^0.3.5: version "0.3.5" @@ -9592,9 +9600,10 @@ typescript-language-server@^0.3.5: vscode-languageserver "^4.4.0" vscode-uri "^1.0.5" -typescript@2.4.1: - version "2.4.1" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.4.1.tgz#c3ccb16ddaa0b2314de031e7e6fee89e5ba346bc" +typescript@3.1.x: + version "3.1.6" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.1.6.tgz#b6543a83cfc8c2befb3f4c8fba6896f5b0c9be68" + integrity sha512-tDMYfVtvpb96msS1lDX9MEdHrW4yOuZ4Kdc4Him9oU796XldPYF/t2+uKoX0BBa0hXXwDlqYQbXY5Rzjzc5hBA== typescript@^3.1.3: version "3.1.3"