Я пытаюсь сгенерировать документацию (используя TypeDoc) моего приложения. У меня довольно сложный сценарий. Так что в моем коде есть некоторая функция, которая возвращает объект, который имеет тип от node_modules/@types
.
Мне нужно включить этот тип в мою документацию, потому что мне нужно показать ссылку на этот @type
и мне тоже нужно показать этот @type
. Итак, я пробовал эти способы:
добавлен путь к этому типу в операторе 'src', например: '**/node_modules/@types/someType/index.d.ts'
. Мой конфиг TypeDoc для этого:
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../MyDocumentation/',
name: 'MyApp',
target: 'es5',
exclude: [
'**/folderA/*.d.ts',
'**/folderB/*.d.ts'
],
excludePrivate: true,
externalPattern: "**/*/{fileX,fileY,fileZ}.ts",
mode: 'file'
},
src: [
'folderA/*.ts',
'folderB/*.ts',
'**/node_modules/@types/someType/*.d.ts'
]
}
}
по значению includeDeclarations как true. Мой конфиг TypeDoc для этого:
typedoc: {
build: {
options: {
module: 'commonjs',
out: '../MyDocumentation/',
name: 'MyApp',
target: 'es5',
exclude: [
'**/node_modules/**',
'**/folderA/*.d.ts',
'**/folderB/*.d.ts'
],
includeDeclarations: true,
excludePrivate: true,
externalPattern: "**/*/{fileX,fileY,fileZ}.ts",
mode: 'file'
},
src: [
'folderA/*.ts',
'folderB/*.ts',
]
}
}
Первый путь был проигнорирован. С первого взгляда я думал, что второй работает хорошо, но кое-что заметил. Я заметил, что полный node_modules
был включен в мою документацию. Но мне не нужно все node_modules
в моей документации. Мне нужен только этот тип.
Я так разочарован, потому что без includeDeclarations моя документация не может найти тип node_modules
, но с ним - включает много избыточного кода.
Есть ли способ сделать это?
Я ищу способ, как включить мой @type
, но без остатка node_modules
.
Я спрашивал 2 дня назад на GitHub в репозитории TypeDoc , но пока без ответа, поэтому я решил создать вопрос здесь.