1.0.3 • Published 2 years ago
@blackwych/typedoc-plugin-categorize-by-path v1.0.3
@blackwych/typedoc-plugin-categorize-by-path
TypeDoc plugin to determine modules and categories from module paths
Features
For each module:
- If any of
categoryPatternsmatched to module path, the captured category will be prepended and the module name will be renamed to the captured one. - The first matched result will be used.
- Nothing will be changed if no pattern matched.
Installation
npm install -D @blackwych/typedoc-plugin-categorize-by-pathUsage
TypeDoc will automatically detect and enable this plugin.
Options
| Option | Type | Defaults | Description |
|---|---|---|---|
categoryPatterns | string[] | [] | RegExp pattern strings that capture category and module names from module paths.Each pattern must contain named capture groups (?<category>...) and (?<module>...). |