Improve CodeDocDependencies for grouped functions and constants #67
Conversation
…deDocDependencies Instead of adding ALL constantsInformation and functionsInformation to CodeDocDependencies of all files containing at least one constant or function, only add information of the groupBy aliases contained in that file.
| return ModuleResolutionKind.NodeJs; | ||
| case 'node16': | ||
| return ModuleResolutionKind.Node16; | ||
| case 'node10': |
There was a problem hiding this comment.
Actually, because this was missing the warning was logged (see "default" case below). Because appearantly, if you don't specify moduleResolutionKind it falls back to "node10"
| return typeArguments[index]; | ||
| } | ||
|
|
||
| export function getCategoryFromEntityKind(entityKind: EntityKind): Category { |
There was a problem hiding this comment.
We were misusing EntityKind for Category. "Category" is the category label in the ArgTypes table and needs to be plural. I separated both types and used the proper "EntityKind"s everywhere.
| /** | ||
| * @exclude-docs | ||
| */ | ||
| hiddenProperty?: unknown; |
There was a problem hiding this comment.
I guess that was a mistake. hiddenProperty was also added to "Item", but in "Item" it's mandatory. Because of that type error, storybook does not startup.
| return argsTableProps; | ||
| }; | ||
|
|
||
| function getCategoryPriority(category: Category) { |
There was a problem hiding this comment.
Priorly, the categories in the ArgTypes table just followed a "random" order.
| collectedConstantsInformation.push(...constantsInformation); | ||
| } | ||
|
|
||
| for (const moduleWithFunctionsOrConstants of modulesWithFunctionsOrConstants) { |
There was a problem hiding this comment.
This is probably the most difficult change to understand.
Priorly, all information on constants and functions have been added as CodeDocDependencies to ALL modules (=files) that contained at least one constant or function with "@include-docs". That does not scale well at all.
Now, all aliases from "@include-docs" within a module are collected and then all grouped constants and functions for only the aliases contained in that file are added as CodeDocDependencies.
3 participants
No description provided.