Skip to content

Commit 109db51

Browse files
feat: add support for raw generic strings in markdown docs
1 parent f308124 commit 109db51

File tree

3 files changed

+29
-11
lines changed

3 files changed

+29
-11
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
},
2222
"license": "MIT",
2323
"devDependencies": {
24-
"@electron/docs-parser": "^0.7.2",
2524
"@continuous-auth/semantic-release-npm": "2.0.0",
25+
"@electron/docs-parser": "^0.11.0",
2626
"@types/debug": "^4.1.4",
2727
"@types/fs-extra": "^5.0.5",
2828
"@types/lodash": "^4.14.123",

src/module-declaration.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ export const generateModuleDeclaration = (
259259
);
260260

261261
moduleAPI.push(
262-
`${prefix}${moduleMethod.name}(${paramString})${
262+
`${prefix}${moduleMethod.name}${moduleMethod.rawGenerics || ''}(${paramString})${
263263
moduleMethod.name === 'constructor'
264264
? ''
265265
: `: ${utils.typify(

yarn.lock

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@
2727
read-pkg "^4.0.0"
2828
registry-auth-token "^3.3.1"
2929

30-
"@electron/docs-parser@^0.7.2":
31-
version "0.7.2"
32-
resolved "https://registry.yarnpkg.com/@electron/docs-parser/-/docs-parser-0.7.2.tgz#f0d5b9f314db519ac1f83359c07c6ec42d3123d1"
33-
integrity sha512-b8D+v9I3OGSL/5AlPYry11UtygskWe1ejwXxBePNst45/AclYoIIQnIlXr51tv8Q+Wsuhqh/fJWHO9yAjF30Uw==
30+
"@electron/docs-parser@^0.11.0":
31+
version "0.11.0"
32+
resolved "https://registry.yarnpkg.com/@electron/docs-parser/-/docs-parser-0.11.0.tgz#182a9732d2fc7b40e3f506d3ab1a06270cdae6e4"
33+
integrity sha512-i+OSWXXchoKVorR6cANqPKYJ1ccLAp+YCPTB+IJVWZ+Xtp6V2VXqLsjoy4mD32ss4CdX/6MLX62pb2sjGmmR6w==
3434
dependencies:
35-
"@types/markdown-it" "^0.0.9"
35+
"@types/markdown-it" "^10.0.0"
3636
chai "^4.2.0"
3737
chalk "^3.0.0"
3838
fs-extra "^8.1.0"
@@ -195,6 +195,11 @@
195195
"@types/minimatch" "*"
196196
"@types/node" "*"
197197

198+
"@types/highlight.js@^9.7.0":
199+
version "9.12.4"
200+
resolved "https://registry.yarnpkg.com/@types/highlight.js/-/highlight.js-9.12.4.tgz#8c3496bd1b50cc04aeefd691140aa571d4dbfa34"
201+
integrity sha512-t2szdkwmg2JJyuCM20e8kR2X59WCE5Zkl4bzm1u1Oukjm79zpbiAv+QjnwLnuuV0WHEcX2NgUItu0pAMKuOPww==
202+
198203
"@types/linkify-it@*":
199204
version "2.1.0"
200205
resolved "https://registry.yarnpkg.com/@types/linkify-it/-/linkify-it-2.1.0.tgz#ea3dd64c4805597311790b61e872cbd1ed2cd806"
@@ -205,12 +210,20 @@
205210
resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.123.tgz#39be5d211478c8dd3bdae98ee75bb7efe4abfe4d"
206211
integrity sha512-pQvPkc4Nltyx7G1Ww45OjVqUsJP4UsZm+GWJpigXgkikZqJgRm4c48g027o6tdgubWHwFRF15iFd+Y4Pmqv6+Q==
207212

208-
"@types/markdown-it@^0.0.9":
209-
version "0.0.9"
210-
resolved "https://registry.yarnpkg.com/@types/markdown-it/-/markdown-it-0.0.9.tgz#a5d552f95216c478e0a27a5acc1b28dcffd989ce"
211-
integrity sha512-IFSepyZXbF4dgSvsk8EsgaQ/8Msv1I5eTL0BZ0X3iGO9jw6tCVtPG8HchIPm3wrkmGdqZOD42kE0zplVi1gYDA==
213+
"@types/markdown-it@^10.0.0":
214+
version "10.0.3"
215+
resolved "https://registry.yarnpkg.com/@types/markdown-it/-/markdown-it-10.0.3.tgz#a9800d14b112c17f1de76ec33eff864a4815eec7"
216+
integrity sha512-daHJk22isOUvNssVGF2zDnnSyxHhFYhtjeX4oQaKD6QzL3ZR1QSgiD1g+Q6/WSWYVogNXYDXODtbgW/WiFCtyw==
212217
dependencies:
218+
"@types/highlight.js" "^9.7.0"
213219
"@types/linkify-it" "*"
220+
"@types/mdurl" "*"
221+
highlight.js "^9.7.0"
222+
223+
"@types/mdurl@*":
224+
version "1.0.2"
225+
resolved "https://registry.yarnpkg.com/@types/mdurl/-/mdurl-1.0.2.tgz#e2ce9d83a613bacf284c7be7d491945e39e1f8e9"
226+
integrity sha512-eC4U9MlIcu2q0KQmXszyn5Akca/0jrQmwDRgpAMJai7qBWq4amIQhZyNau4VYGtCeALvW1/NtjzJJ567aZxfKA==
214227

215228
"@types/minimatch@*":
216229
version "3.0.3"
@@ -2137,6 +2150,11 @@ [email protected]:
21372150
resolved "https://registry.yarnpkg.com/he/-/he-1.2.0.tgz#84ae65fa7eafb165fddb61566ae14baf05664f0f"
21382151
integrity sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==
21392152

2153+
highlight.js@^9.7.0:
2154+
version "9.18.5"
2155+
resolved "https://registry.yarnpkg.com/highlight.js/-/highlight.js-9.18.5.tgz#d18a359867f378c138d6819edfc2a8acd5f29825"
2156+
integrity sha512-a5bFyofd/BHCX52/8i8uJkjr9DYwXIPnM/plwI6W7ezItLGqzt7X2G2nXuYSfsIJdkwwj/g9DG1LkcGJI/dDoA==
2157+
21402158
hook-std@^1.1.0:
21412159
version "1.2.0"
21422160
resolved "https://registry.yarnpkg.com/hook-std/-/hook-std-1.2.0.tgz#b37d533ea5f40068fe368cb4d022ee1992588c27"

0 commit comments

Comments
 (0)