Как включить компоненты углового материала в мой TypeDoc? - PullRequest
Новая
       37

Как включить компоненты углового материала в мой TypeDoc?

0 голосов
/ 05 ноября 2019

У нас уже есть TypeDoc, включенный в наш проект Storybook, и он работает для наших собственных компонентов. Мы также хотели бы иметь TypeDocs, сгенерированные для общих компонентов Material.

Я уже много возился с аргументом --exclude для typedoc, но почему-то не могу заставить его работать.

Пока что запись в package.json выглядит следующим образом: "typedoc": "typedoc --mode modules --exclude **/*.spec.ts* --out build/typedoc --json build/typedoc/typedoc.json projects/" Я пробовал, добавляя --includeDeclarations к выражению и изменяя шаблон --exclude, чтобы исключить все в node_modules, кроме node_modules/@angular/material, но покабезрезультатно. Например, я попробовал шаблон:

**/{node_modules/!(@angular/material)/**,*.spec.ts}

Но я всегда получаю ошибки вроде

"/**" kann syntaktisch an dieser Stelle nicht verarbeitet werden.

Я никогда не работал с minimatchили typedoc, так что помощь очень ценится.

Есть идеи?

Обновление:

Я смог решить эту проблему, создав файл typedoc.json в том же каталогекак мой package.json. Сценарий typedoc теперь: "typedoc --options ./typedoc.json projects/", а содержание typedoc.json: 

{
    "out": "build/typedoc",
    "json": "build/typedoc/typedoc.json",
    "mode": "modules",
    "includeDeclarations": true,
    "exclude": [
        "**/*.spec.ts",
        "**/node_modules/!(@angular)/**",
        "**/node_modules/@angular/!(material)/**"
    ]
}

Поведение соответствует ожидаемому.

...