Skip to content

Commit 5ed3135

Browse files
authored
build(typedoc): Make sure typedoc builds correctly (#2827)
1 parent a0dd71a commit 5ed3135

File tree

3 files changed

+58
-89
lines changed

3 files changed

+58
-89
lines changed

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
"devDependencies": {
4141
"@google-cloud/storage": "^2.5.0",
4242
"@size-limit/preset-small-lib": "^4.5.5",
43-
"@strictsoftware/typedoc-plugin-monorepo": "^0.2.1",
43+
"@strictsoftware/typedoc-plugin-monorepo": "^0.3.1",
4444
"@types/chai": "^4.1.3",
4545
"@types/jest": "^24.0.11",
4646
"@types/mocha": "^5.2.0",
@@ -60,7 +60,7 @@
6060
"sinon": "^7.3.2",
6161
"size-limit": "^4.5.5",
6262
"ts-jest": "^24.0.2",
63-
"typedoc": "^0.14.2",
63+
"typedoc": "^0.18.0",
6464
"typescript": "3.9.7"
6565
},
6666
"resolutions": {

typedoc.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,17 @@ module.exports = {
1010
'**/esm/**/*',
1111
'**/build/**/*',
1212
'**/packages/typescript/**/*',
13-
// TODO: Don't exclude React
14-
'**/packages/react/**/*',
13+
'**/packages/eslint-*/**/*',
1514
],
1615
mode: 'modules',
1716
excludeExternals: true,
17+
includeDeclarations: true,
18+
includeVersion: true,
1819
excludeNotExported: true,
1920
excludePrivate: true,
21+
// Turned on as @sentry/angular uses decorators
22+
experimentalDecorators: true,
23+
// Turned on for @sentry/react
24+
jsx: 'react',
2025
'external-modulemap': '.*/packages/([^/]+)/.*',
2126
};

yarn.lock

Lines changed: 49 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -2407,13 +2407,12 @@
24072407
webpack "^4.43.0"
24082408
webpack-bundle-analyzer "^3.8.0"
24092409

2410-
"@strictsoftware/typedoc-plugin-monorepo@^0.2.1":
2411-
version "0.2.2"
2412-
resolved "https://registry.yarnpkg.com/@strictsoftware/typedoc-plugin-monorepo/-/typedoc-plugin-monorepo-0.2.2.tgz#18a203dbd13bbd0855e48b532d1f088ed729e9df"
2413-
integrity sha512-Djx+WA3/z2nc2ngQC52LAlORHG8zMQLb9BH4mQy7X69NKhAV0imiUxUVXeSkaFUxS7f79FAydYS4AxJYUhPnVA==
2410+
"@strictsoftware/typedoc-plugin-monorepo@^0.3.1":
2411+
version "0.3.1"
2412+
resolved "https://registry.yarnpkg.com/@strictsoftware/typedoc-plugin-monorepo/-/typedoc-plugin-monorepo-0.3.1.tgz#83a704bad2cf90a05f62f1c2587b0be09693a9a0"
2413+
integrity sha512-b7oolCeKZ40jyEfQrDd/Z216M5ZE4tRML0B0bV35tUIALoQsBBA7dz3Kr+X6DtbZA7FQmaqNGS6WAt7zxLL7wg==
24142414
dependencies:
24152415
highlight.js "^9.15.6"
2416-
marked "^0.8.0"
24172416

24182417
"@testing-library/dom@^7.17.1":
24192418
version "7.21.4"
@@ -2740,7 +2739,7 @@
27402739
"@types/qs" "*"
27412740
"@types/serve-static" "*"
27422741

2743-
"@types/fs-extra@^5.0.3", "@types/fs-extra@^5.0.5":
2742+
"@types/fs-extra@^5.0.5":
27442743
version "5.1.0"
27452744
resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-5.1.0.tgz#2a325ef97901504a3828718c390d34b8426a10a1"
27462745
integrity sha512-AInn5+UBFIK9FK5xc9yP5e3TQSPNNgjHByqYcj9g5elVBnDQcQL7PlO1CIRy2gWlbwK7UPYqi7vRvFA44dCmYQ==
@@ -2762,18 +2761,6 @@
27622761
"@types/minimatch" "*"
27632762
"@types/node" "*"
27642763

2765-
"@types/handlebars@^4.0.38":
2766-
version "4.1.0"
2767-
resolved "https://registry.yarnpkg.com/@types/handlebars/-/handlebars-4.1.0.tgz#3fcce9bf88f85fe73dc932240ab3fb682c624850"
2768-
integrity sha512-gq9YweFKNNB1uFK71eRqsd4niVkXrxHugqWFQkeLRJvGjnxsLr16bYtcsG4tOFwmYi0Bax+wCkbf1reUfdl4kA==
2769-
dependencies:
2770-
handlebars "*"
2771-
2772-
"@types/highlight.js@^9.12.3":
2773-
version "9.12.4"
2774-
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.4.tgz#8c3496bd1b50cc04aeefd691140aa571d4dbfa34"
2775-
integrity sha512-t2szdkwmg2JJyuCM20e8kR2X59WCE5Zkl4bzm1u1Oukjm79zpbiAv+QjnwLnuuV0WHEcX2NgUItu0pAMKuOPww==
2776-
27772764
"@types/history-4@npm:@types/[email protected]", "@types/history-5@npm:@types/[email protected]", "@types/history@*":
27782765
name "@types/history-4"
27792766
version "4.7.7"
@@ -2851,21 +2838,11 @@
28512838
resolved "https://registry.yarnpkg.com/@types/json5/-/json5-0.0.29.tgz#ee28707ae94e11d2b827bcbe5270bcea7f3e71ee"
28522839
integrity sha1-7ihweulOEdK4J7y+UnC86n8+ce4=
28532840

2854-
"@types/lodash@^4.14.110":
2855-
version "4.14.158"
2856-
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.158.tgz#b38ea8b6fe799acd076d7a8d7ab71c26ef77f785"
2857-
integrity sha512-InCEXJNTv/59yO4VSfuvNrZHt7eeNtWQEgnieIA+mIC+MOWM9arOWG2eQ8Vhk6NbOre6/BidiXhkZYeDY9U35w==
2858-
28592841
"@types/lru-cache@^5.1.0":
28602842
version "5.1.0"
28612843
resolved "https://registry.yarnpkg.com/@types/lru-cache/-/lru-cache-5.1.0.tgz#57f228f2b80c046b4a1bd5cac031f81f207f4f03"
28622844
integrity sha512-RaE0B+14ToE4l6UqdarKPnXwVDuigfFv+5j9Dze/Nqr23yyuqdNvzcZi3xB+3Agvi5R4EOgAksfv3lXX4vBt9w==
28632845

2864-
"@types/marked@^0.4.0":
2865-
version "0.4.2"
2866-
resolved "https://registry.yarnpkg.com/@types/marked/-/marked-0.4.2.tgz#64a89e53ea37f61cc0f3ee1732c555c2dbf6452f"
2867-
integrity sha512-cDB930/7MbzaGF6U3IwSQp6XBru8xWajF5PV2YZZeV8DyiliTuld11afVztGI9+yJZ29il5E+NpGA6ooV/Cjkg==
2868-
28692846
28702847
version "2.1.33"
28712848
resolved "https://registry.yarnpkg.com/@types/md5/-/md5-2.1.33.tgz#8c8dba30df4ad0e92296424f08c4898dd808e8df"
@@ -2878,7 +2855,7 @@
28782855
resolved "https://registry.yarnpkg.com/@types/mime/-/mime-2.0.3.tgz#c893b73721db73699943bfc3653b1deb7faa4a3a"
28792856
integrity sha512-Jus9s4CDbqwocc5pOAnh8ShfrnMcPHuJYzVcSUU7lrh8Ni5HuIqX3oilL86p3dlTrk0LzHRCgA/GQ7uNCw6l2Q==
28802857

2881-
"@types/minimatch@*", "@types/minimatch@3.0.3", "@types/minimatch@^3.0.3":
2858+
"@types/minimatch@*", "@types/minimatch@^3.0.3":
28822859
version "3.0.3"
28832860
resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
28842861
integrity sha512-tHq6qdbT9U1IRSGf14CL0pUlULksvY9OZ+5eEgl1N7t+OA3tGvNpxJCzuKQlsNgCVwbAs670L1vcVQi8j9HjnA==
@@ -3012,14 +2989,6 @@
30122989
"@types/express-serve-static-core" "*"
30132990
"@types/mime" "*"
30142991

3015-
"@types/shelljs@^0.8.0":
3016-
version "0.8.8"
3017-
resolved "https://registry.yarnpkg.com/@types/shelljs/-/shelljs-0.8.8.tgz#e439c69929b88a2c8123c1a55e09eb708315addf"
3018-
integrity sha512-lD3LWdg6j8r0VRBFahJVaxoW0SIcswxKaFUrmKl33RJVeeoNYQAz4uqCJ5Z6v4oIBOsC5GozX+I5SorIKiTcQA==
3019-
dependencies:
3020-
"@types/glob" "*"
3021-
"@types/node" "*"
3022-
30232992
"@types/sinon@^7.0.11":
30242993
version "7.5.2"
30252994
resolved "https://registry.yarnpkg.com/@types/sinon/-/sinon-7.5.2.tgz#5e2f1d120f07b9cda07e5dedd4f3bf8888fccdb9"
@@ -9447,7 +9416,7 @@ fs-extra@^8.0.0, fs-extra@^8.0.1, fs-extra@^8.1.0:
94479416
jsonfile "^4.0.0"
94489417
universalify "^0.1.0"
94499418

9450-
fs-extra@^9.0.0:
9419+
fs-extra@^9.0.0, fs-extra@^9.0.1:
94519420
version "9.0.1"
94529421
resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-9.0.1.tgz#910da0062437ba4c39fedd863f1675ccfefcb9fc"
94539422
integrity sha512-h2iAoN838FqAFJY2/qVpzFXy+EBxfVE220PalAqQLDVsFOHLJrZvut5puAbCdNv6WJk+B8ihI+k0c7JK5erwqQ==
@@ -10029,7 +9998,7 @@ gzip-size@^5.0.0:
100299998
duplexer "^0.1.1"
100309999
pify "^4.0.1"
1003110000

10032-
handlebars@*, handlebars@^4.0.1, handlebars@^4.0.11, handlebars@^4.0.4, handlebars@^4.0.6, handlebars@^4.3.1, handlebars@^4.7.3, handlebars@^4.7.4, handlebars@^4.7.6:
10001+
handlebars@^4.0.1, handlebars@^4.0.11, handlebars@^4.0.4, handlebars@^4.3.1, handlebars@^4.7.3, handlebars@^4.7.4, handlebars@^4.7.6:
1003310002
version "4.7.6"
1003410003
resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.6.tgz#d4c05c1baf90e9945f77aa68a7a219aa4a7df74e"
1003510004
integrity sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==
@@ -10234,10 +10203,15 @@ hex-color-regex@^1.1.0:
1023410203
resolved "https://registry.yarnpkg.com/hex-color-regex/-/hex-color-regex-1.1.0.tgz#4c06fccb4602fe2602b3c93df82d7e7dbf1a8a8e"
1023510204
integrity sha512-l9sfDFsuqtOqKDsQdqrMRk0U85RZc0RtOR9yPI7mRVOa4FsR/BVnZ0shmQRM96Ji99kYZP/7hn1cedc1+ApsTQ==
1023610205

10237-
highlight.js@^9.13.1, highlight.js@^9.15.6:
10238-
version "9.18.1"
10239-
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.18.1.tgz#ed21aa001fe6252bb10a3d76d47573c6539fe13c"
10240-
integrity sha512-OrVKYz70LHsnCgmbXctv/bfuvntIKDz177h0Co37DQ5jamGZLVmoCVMtjMtNZY3X9DrCcKfklHPNeA0uPZhSJg==
10206+
highlight.js@^10.0.0:
10207+
version "10.1.2"
10208+
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-10.1.2.tgz#c20db951ba1c22c055010648dfffd7b2a968e00c"
10209+
integrity sha512-Q39v/Mn5mfBlMff9r+zzA+gWxRsCRKwEMvYTiisLr/XUiFI/4puWt0Ojdko3R3JCNWGdOWaA5g/Yxqa23kC5AA==
10210+
10211+
highlight.js@^9.15.6:
10212+
version "9.18.3"
10213+
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.18.3.tgz#a1a0a2028d5e3149e2380f8a865ee8516703d634"
10214+
integrity sha512-zBZAmhSupHIl5sITeMqIJnYCDfAEc3Gdkqj65wC1lpI468MMQeeQkhcIAvk+RylAkxrCcI9xy9piHiXeQ1BdzQ==
1024110215

1024210216
"history-4@npm:[email protected]":
1024310217
version "4.6.0"
@@ -12719,6 +12693,11 @@ lru_map@^0.3.3:
1271912693
resolved "https://registry.yarnpkg.com/lru_map/-/lru_map-0.3.3.tgz#b5c8351b9464cbd750335a79650a0ec0e56118dd"
1272012694
integrity sha1-tcg1G5Rky9dQM1p5ZQoOwOVhGN0=
1272112695

12696+
lunr@^2.3.8:
12697+
version "2.3.8"
12698+
resolved "https://registry.yarnpkg.com/lunr/-/lunr-2.3.8.tgz#a8b89c31f30b5a044b97d2d28e2da191b6ba2072"
12699+
integrity sha512-oxMeX/Y35PNFuZoHp+jUj5OSEmLCaIH4KTFJh7a93cHBoFmpw2IoPs22VIz7vyO2YUnx2Tn9dzIwO2P/4quIRg==
12700+
1272212701
macos-release@^2.2.0:
1272312702
version "2.4.1"
1272412703
resolved "https://registry.yarnpkg.com/macos-release/-/macos-release-2.4.1.tgz#64033d0ec6a5e6375155a74b1a1eba8e509820ac"
@@ -12878,15 +12857,10 @@ markdown-it@^8.3.1:
1287812857
mdurl "^1.0.1"
1287912858
uc.micro "^1.0.5"
1288012859

12881-
marked@^0.4.0:
12882-
version "0.4.0"
12883-
resolved "https://registry.yarnpkg.com/marked/-/marked-0.4.0.tgz#9ad2c2a7a1791f10a852e0112f77b571dce10c66"
12884-
integrity sha512-tMsdNBgOsrUophCAFQl0XPe6Zqk/uy9gnue+jIIKhykO51hxyu6uNx7zBPy0+y/WKYVZZMspV9YeXLNdKk+iYw==
12885-
12886-
marked@^0.8.0:
12887-
version "0.8.2"
12888-
resolved "https://registry.yarnpkg.com/marked/-/marked-0.8.2.tgz#4faad28d26ede351a7a1aaa5fec67915c869e355"
12889-
integrity sha512-EGwzEeCcLniFX51DhTpmTom+dSA/MG/OBUDjnWtHbEnjAH180VzUeAw+oE4+Zv+CoYBWyRlYOTR0N8SO9R1PVw==
12860+
marked@^1.1.1:
12861+
version "1.1.1"
12862+
resolved "https://registry.yarnpkg.com/marked/-/marked-1.1.1.tgz#e5d61b69842210d5df57b05856e0c91572703e6a"
12863+
integrity sha512-mJzT8D2yPxoPh7h0UXkB+dBj4FykPJ2OIfxAWeIHrvoHDkFxukV/29QxoFQoPM6RLEwhIFdJpmKBlqVM3s2ZIw==
1289012864

1289112865
matcher-collection@^1.0.0, matcher-collection@^1.1.1:
1289212866
version "1.1.2"
@@ -14957,7 +14931,7 @@ process@^0.11.10:
1495714931
resolved "https://registry.yarnpkg.com/process/-/process-0.11.10.tgz#7332300e840161bda3e69a1d1d91a7d4bc16f182"
1495814932
integrity sha1-czIwDoQBYb2j5podHZGn1LwW8YI=
1495914933

14960-
progress@^2.0.0:
14934+
progress@^2.0.0, progress@^2.0.3:
1496114935
version "2.0.3"
1496214936
resolved "https://registry.yarnpkg.com/progress/-/progress-2.0.3.tgz#7e8cf8d8f5b8f239c1bc68beb4eb78567d572ef8"
1496314937
integrity sha512-7PiHtLll5LdnKIMw100I+8xJXR5gW2QwWYkT6iJva0bXitZKa/XMrSbdmg3r2Xnaidz9Qumd0VPaMrZlF9V9sA==
@@ -16375,7 +16349,7 @@ shell-quote@^1.6.1:
1637516349
resolved "https://registry.yarnpkg.com/shell-quote/-/shell-quote-1.7.2.tgz#67a7d02c76c9da24f99d20808fcaded0e0e04be2"
1637616350
integrity sha512-mRz/m/JVscCrkMyPqHc/bczi3OQHkLTqXHEFu0zDhK/qfv3UcOA4SVmRCLmos4bhjr9ekVQubj/R7waKapmiQg==
1637716351

16378-
shelljs@^0.8.2:
16352+
shelljs@^0.8.4:
1637916353
version "0.8.4"
1638016354
resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.4.tgz#de7684feeb767f8716b326078a8a00875890e3c2"
1638116355
integrity sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==
@@ -17899,33 +17873,28 @@ typedarray@^0.0.6:
1789917873
resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
1790017874
integrity sha1-hnrHTjhkGHsdPUfZlqeOxciDB3c=
1790117875

17902-
typedoc-default-themes@^0.5.0:
17903-
version "0.5.0"
17904-
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.5.0.tgz#6dc2433e78ed8bea8e887a3acde2f31785bd6227"
17905-
integrity sha1-bcJDPnjti+qOiHo6zeLzF4W9Yic=
17906-
17907-
typedoc@^0.14.2:
17908-
version "0.14.2"
17909-
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.14.2.tgz#769f457f4f9e4bdb8b5f3b177c86b6a31d8c3dc3"
17910-
integrity sha512-aEbgJXV8/KqaVhcedT7xG6d2r+mOvB5ep3eIz1KuB5sc4fDYXcepEEMdU7XSqLFO5hVPu0nllHi1QxX2h/QlpQ==
17911-
dependencies:
17912-
"@types/fs-extra" "^5.0.3"
17913-
"@types/handlebars" "^4.0.38"
17914-
"@types/highlight.js" "^9.12.3"
17915-
"@types/lodash" "^4.14.110"
17916-
"@types/marked" "^0.4.0"
17917-
"@types/minimatch" "3.0.3"
17918-
"@types/shelljs" "^0.8.0"
17919-
fs-extra "^7.0.0"
17920-
handlebars "^4.0.6"
17921-
highlight.js "^9.13.1"
17922-
lodash "^4.17.10"
17923-
marked "^0.4.0"
17876+
typedoc-default-themes@^0.10.2:
17877+
version "0.10.2"
17878+
resolved "https://registry.yarnpkg.com/typedoc-default-themes/-/typedoc-default-themes-0.10.2.tgz#743380a80afe62c5ef92ca1bd4abe2ac596be4d2"
17879+
integrity sha512-zo09yRj+xwLFE3hyhJeVHWRSPuKEIAsFK5r2u47KL/HBKqpwdUSanoaz5L34IKiSATFrjG5ywmIu98hPVMfxZg==
17880+
dependencies:
17881+
lunr "^2.3.8"
17882+
17883+
typedoc@^0.18.0:
17884+
version "0.18.0"
17885+
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.18.0.tgz#8bf53ddd7df5b8966b52c946929a09549d78682b"
17886+
integrity sha512-UgDQwapCGQCCdYhEQzQ+kGutmcedklilgUGf62Vw6RdI29u6FcfAXFQfRTiJEbf16aK3YnkB20ctQK1JusCRbA==
17887+
dependencies:
17888+
fs-extra "^9.0.1"
17889+
handlebars "^4.7.6"
17890+
highlight.js "^10.0.0"
17891+
lodash "^4.17.15"
17892+
lunr "^2.3.8"
17893+
marked "^1.1.1"
1792417894
minimatch "^3.0.0"
17925-
progress "^2.0.0"
17926-
shelljs "^0.8.2"
17927-
typedoc-default-themes "^0.5.0"
17928-
typescript "3.2.x"
17895+
progress "^2.0.3"
17896+
shelljs "^0.8.4"
17897+
typedoc-default-themes "^0.10.2"
1792917898

1793017899
typescript-memoize@^1.0.0-alpha.3:
1793117900
version "1.0.0-alpha.3"
@@ -17934,11 +17903,6 @@ typescript-memoize@^1.0.0-alpha.3:
1793417903
dependencies:
1793517904
core-js "2.4.1"
1793617905

17937-
17938-
version "3.2.4"
17939-
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.2.4.tgz#c585cb952912263d915b462726ce244ba510ef3d"
17940-
integrity sha512-0RNDbSdEokBeEAkgNbxJ+BLwSManFy9TeXz8uW+48j/xhEXv1ePME60olyzw2XzUqUBNAYFeJadIqAgNqIACwg==
17941-
1794217906
1794317907
version "3.9.7"
1794417908
resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.7.tgz#98d600a5ebdc38f40cb277522f12dc800e9e25fa"

0 commit comments

Comments
 (0)