Skip to content

Feature request: ability to document relationships #281

@MShekow

Description

@MShekow

While the graphs for the module hierarchy / component hierarchy / dependency injection are already quite useful, I image that being able to document the relationship (and have the graph generator add it as label to the edges of a graph would be very useful.

Exemplary, in a component hierarchy graph, component A includes components B and C. But what the graph does not show (yet), is that A only includes B or C on specific conditions. For instance, B might only be included if the user is logged into the application, otherwise C is included.

I don't have a concrete implementation approach for you, but it would be nice if a developer could somehow add this piece of knowledge (in the form of a simple string). For instance, for the component hierarchy, as a developer I would be fine with adding TSDoc to my component classes, and have AngularTools looks for a specific keyword, e.g. @linksto <name of other component> - <text describing the relation>, which it uses to enrich the links (graph edges) that it detects as usual.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions