Function transformDirLocation

transformDirLocation(
    entity: Entity,
    dirAnnotation: ParsedLocationAnnotation,
    scmIntegrations: ScmIntegrationRegistry,
): { target: string; type: "url" | "dir" }
TechDocs references of type dir are relative the source location of the entity. This function transforms relative references to absolute ones, based on the location the entity was ingested from. If the entity was registered by a url location, it returns a url location with a resolved target that points to the targeted subfolder. If the entity was registered by a file location, it returns an absolute dir location.
Parameters
- entity: Entity
  the entity with annotations
- dirAnnotation: ParsedLocationAnnotation
  the parsed techdocs-ref annotation of type 'dir'
- scmIntegrations: ScmIntegrationRegistry
  access to the scmIntegration to do url transformations
Returns { target: string; type: "url" | "dir" }
the transformed location with an absolute target.

Throws
if the entity doesn't specify a dir location or is ingested from an unsupported location.
- Defined in plugins/techdocs-node/src/helpers.ts:80