🔭 Callidescope Output

Renders call-graph findings into markdown, mermaid, and JSON output formats.

This package sits between @callidescope/graph, which it depends on for the shapes it renders, and @callidescope/cli, which orchestrates a run and hands this package the findings.

npm install --save-dev @callidescope/output

What This Package Owns

• output-markdown — anchored-block splicing into markdown files
• output-json — JSON file output
• report — assembles findings, as markdown or a mermaid diagram, into the reportable shape
• project-reports — per-project report sections, scoping a run's findings to the project each one came from

Test

nx run callidescope-output:vitest

👔 Conformetry

This project was generated from the nestjs-service-project conformetry template.

🔭 Callidescope

Call stacks traced through projects/ic-suite/callidescope/callidescope-output, deepest first. Each frame shows what it takes, what it returns, and what its documentation says.

Limits

What this project is judged against, as declared in its own callidescope.config.ts.

Call stacks (depth)

1. OutputMarkdownService.syncAnchoredBlock — depth ≥ 4 · orphan-root

🚀 OutputMarkdownService.syncAnchoredBlock(…): boolean [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:161]
  └─> OutputMarkdownService.syncAnchoredBlock(args: SyncAnchoredBlockArguments): boolean [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:206]
     ↳ Splices the anchored block into a file.
    └─> OutputMarkdownService.buildBlockPattern(destination: SyncAnchoredBlockArguments["destination"]): RegExp [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:54]
       ↳ Builds the pattern matching everything between the two anchors.
      └─> OutputMarkdownService.escapePattern(value: string): string [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:63]
         ↳ Escapes a marker so it can sit inside a pattern.

2. OutputMarkdownService.wrapInAnchors — depth 2 · orphan-root

🚀 OutputMarkdownService.wrapInAnchors(override: string | undefined): string [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:168]
  └─> OutputMarkdownService.wrapInAnchors(args: WrapInAnchorsArguments): string [projects/ic-suite/callidescope/callidescope-output/src/modules/output-markdown/output-markdown.service.ts:236]
     ↳ Wraps content in the configured anchors.

Breadth

🕸️ Codependix

Dependency graphs exported by codependix, regenerated by nx run configuration:codependix:write.

Nx Neighborhood

graph LR
  callidescope_cli["callidescope-cli"]
  callidescope_configuration["callidescope-configuration"]
  callidescope_core["callidescope-core"]
  callidescope_graph["callidescope-graph"]
  callidescope_nx["callidescope-nx"]
  callidescope_output["callidescope-output"]
  observability["observability"]
  callidescope_cli --> callidescope_output
  callidescope_nx --> callidescope_output
  callidescope_output --> callidescope_configuration
  callidescope_output --> callidescope_core
  callidescope_output --> callidescope_graph
  callidescope_output --> observability
  classDef subject fill:#7c3aed,color:#fff,stroke:#4c1d95,stroke-width:2px
  class callidescope_output subject

NestJS Module Graph

flowchart LR
  AddressReportModule
  CallablesModule
  ClassesModule
  DocumentationModule
  EdgesModule
  GraphModule
  LoggerModule([LoggerModule])
  OutputJsonModule
  OutputMarkdownModule
  ProgramModule
  ProjectReportsModule
  ReportFindingsModule
  ReportModule
  SignaturesModule
  WorkspaceModule
  WriteDestinationsModule
  AddressReportModule --> ReportModule
  CallablesModule --> ProgramModule
  CallablesModule --> WorkspaceModule
  EdgesModule --> CallablesModule
  EdgesModule --> ClassesModule
  EdgesModule --> ProgramModule
  EdgesModule --> WorkspaceModule
  GraphModule --> DocumentationModule
  GraphModule --> EdgesModule
  GraphModule --> SignaturesModule
  ProgramModule --> WorkspaceModule
  ProjectReportsModule --> GraphModule
  ProjectReportsModule --> SignaturesModule
  WriteDestinationsModule --> OutputJsonModule
  WriteDestinationsModule --> OutputMarkdownModule
  WriteDestinationsModule --> ReportModule

Rounded modules are global: every module can inject them, so their edges are left out.

File Imports

graph LR
  file_callidescope_config_ts["callidescope.config.ts"]
  file_codependix_config_ts["codependix.config.ts"]
  file_codometer_config_ts["codometer.config.ts"]
  file_coinagerie_config_ts["coinagerie.config.ts"]
  file_eslint_config_ts["eslint.config.ts"]
  file_src_index_ts["src/index.ts"]
  file_src_modules_address_report_address_report_constants_ts["src/modules/address-report/address-report.constants.ts"]
  file_src_modules_address_report_address_report_module_ts["src/modules/address-report/address-report.module.ts"]
  file_src_modules_address_report_address_report_service_ts["src/modules/address-report/address-report.service.ts"]
  file_src_modules_address_report_address_report_service_unit_test_ts["src/modules/address-report/address-report.service.unit.test.ts"]
  file_src_modules_address_report_address_report_types_ts["src/modules/address-report/address-report.types.ts"]
  file_src_modules_output_json_output_json_constants_ts["src/modules/output-json/output-json.constants.ts"]
  file_src_modules_output_json_output_json_module_ts["src/modules/output-json/output-json.module.ts"]
  file_src_modules_output_json_output_json_service_ts["src/modules/output-json/output-json.service.ts"]
  file_src_modules_output_json_output_json_service_unit_test_ts["src/modules/output-json/output-json.service.unit.test.ts"]
  file_src_modules_output_json_output_json_types_ts["src/modules/output-json/output-json.types.ts"]
  file_src_modules_output_markdown_output_markdown_constants_ts["src/modules/output-markdown/output-markdown.constants.ts"]
  file_src_modules_output_markdown_output_markdown_module_ts["src/modules/output-markdown/output-markdown.module.ts"]
  file_src_modules_output_markdown_output_markdown_service_ts["src/modules/output-markdown/output-markdown.service.ts"]
  file_src_modules_output_markdown_output_markdown_service_unit_test_ts["src/modules/output-markdown/output-markdown.service.unit.test.ts"]
  file_src_modules_output_markdown_output_markdown_types_ts["src/modules/output-markdown/output-markdown.types.ts"]
  file_src_modules_project_reports_project_reports_constants_ts["src/modules/project-reports/project-reports.constants.ts"]
  file_src_modules_project_reports_project_reports_module_ts["src/modules/project-reports/project-reports.module.ts"]
  file_src_modules_project_reports_project_reports_service_ts["src/modules/project-reports/project-reports.service.ts"]
  file_src_modules_project_reports_project_reports_service_unit_test_ts["src/modules/project-reports/project-reports.service.unit.test.ts"]
  file_src_modules_project_reports_project_reports_types_ts["src/modules/project-reports/project-reports.types.ts"]
  file_src_modules_report_findings_report_findings_constants_ts["src/modules/report-findings/report-findings.constants.ts"]
  file_src_modules_report_findings_report_findings_module_ts["src/modules/report-findings/report-findings.module.ts"]
  file_src_modules_report_findings_report_findings_service_ts["src/modules/report-findings/report-findings.service.ts"]
  file_src_modules_report_findings_report_findings_service_unit_test_ts["src/modules/report-findings/report-findings.service.unit.test.ts"]
  file_src_modules_report_findings_report_findings_types_ts["src/modules/report-findings/report-findings.types.ts"]
  file_src_modules_report_markdown_report_service_ts["src/modules/report/markdown-report.service.ts"]
  file_src_modules_report_markdown_report_service_unit_test_ts["src/modules/report/markdown-report.service.unit.test.ts"]
  file_src_modules_report_mermaid_report_service_ts["src/modules/report/mermaid-report.service.ts"]
  file_src_modules_report_mermaid_report_service_unit_test_ts["src/modules/report/mermaid-report.service.unit.test.ts"]
  file_src_modules_report_report_constants_ts["src/modules/report/report.constants.ts"]
  file_src_modules_report_report_module_ts["src/modules/report/report.module.ts"]
  file_src_modules_report_report_service_ts["src/modules/report/report.service.ts"]
  file_src_modules_report_report_service_unit_test_ts["src/modules/report/report.service.unit.test.ts"]
  file_src_modules_report_report_types_ts["src/modules/report/report.types.ts"]
  file_src_modules_report_workspace_report_service_ts["src/modules/report/workspace-report.service.ts"]
  file_src_modules_report_workspace_report_service_unit_test_ts["src/modules/report/workspace-report.service.unit.test.ts"]
  file_src_modules_write_destinations_write_destinations_constants_ts["src/modules/write-destinations/write-destinations.constants.ts"]
  file_src_modules_write_destinations_write_destinations_module_ts["src/modules/write-destinations/write-destinations.module.ts"]
  file_src_modules_write_destinations_write_destinations_service_ts["src/modules/write-destinations/write-destinations.service.ts"]
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts["src/modules/write-destinations/write-destinations.service.unit.test.ts"]
  file_src_modules_write_destinations_write_destinations_types_ts["src/modules/write-destinations/write-destinations.types.ts"]
  file_testing_mocks_ts["testing/mocks.ts"]
  file_testing_modules_ts["testing/modules.ts"]
  file_testing_setup_ts["testing/setup.ts"]
  file_vite_config_ts["vite.config.ts"]
  file_vitest_config_ts["vitest.config.ts"]
  file_src_modules_address_report_address_report_module_ts --> file_src_modules_address_report_address_report_service_ts
  file_src_modules_address_report_address_report_module_ts --> file_src_modules_report_report_module_ts
  file_src_modules_address_report_address_report_service_ts --> file_src_modules_address_report_address_report_types_ts
  file_src_modules_address_report_address_report_service_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_address_report_address_report_service_ts --> file_src_modules_report_report_service_ts
  file_src_modules_address_report_address_report_service_ts --> file_src_modules_report_report_types_ts
  file_src_modules_address_report_address_report_service_unit_test_ts --> file_src_modules_address_report_address_report_service_ts
  file_src_modules_address_report_address_report_service_unit_test_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_address_report_address_report_service_unit_test_ts --> file_src_modules_report_report_service_ts
  file_src_modules_address_report_address_report_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_output_json_output_json_module_ts --> file_src_modules_output_json_output_json_service_ts
  file_src_modules_output_json_output_json_service_ts --> file_src_modules_output_json_output_json_types_ts
  file_src_modules_output_json_output_json_service_unit_test_ts --> file_src_modules_output_json_output_json_service_ts
  file_src_modules_output_json_output_json_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_output_json_output_json_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_output_markdown_output_markdown_module_ts --> file_src_modules_output_markdown_output_markdown_service_ts
  file_src_modules_output_markdown_output_markdown_service_ts --> file_src_modules_output_markdown_output_markdown_constants_ts
  file_src_modules_output_markdown_output_markdown_service_ts --> file_src_modules_output_markdown_output_markdown_types_ts
  file_src_modules_output_markdown_output_markdown_service_unit_test_ts --> file_src_modules_output_markdown_output_markdown_constants_ts
  file_src_modules_output_markdown_output_markdown_service_unit_test_ts --> file_src_modules_output_markdown_output_markdown_service_ts
  file_src_modules_output_markdown_output_markdown_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_output_markdown_output_markdown_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_project_reports_project_reports_module_ts --> file_src_modules_project_reports_project_reports_service_ts
  file_src_modules_project_reports_project_reports_service_ts --> file_src_modules_project_reports_project_reports_constants_ts
  file_src_modules_project_reports_project_reports_service_ts --> file_src_modules_project_reports_project_reports_types_ts
  file_src_modules_project_reports_project_reports_service_unit_test_ts --> file_src_modules_project_reports_project_reports_service_ts
  file_src_modules_project_reports_project_reports_service_unit_test_ts --> file_src_modules_project_reports_project_reports_types_ts
  file_src_modules_project_reports_project_reports_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_project_reports_project_reports_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_report_findings_report_findings_module_ts --> file_src_modules_report_findings_report_findings_service_ts
  file_src_modules_report_findings_report_findings_service_ts --> file_src_modules_report_findings_report_findings_types_ts
  file_src_modules_report_findings_report_findings_service_unit_test_ts --> file_src_modules_report_findings_report_findings_service_ts
  file_src_modules_report_findings_report_findings_service_unit_test_ts --> file_src_modules_report_findings_report_findings_types_ts
  file_src_modules_report_findings_report_findings_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_report_markdown_report_service_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_report_markdown_report_service_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_markdown_report_service_ts --> file_src_modules_report_report_service_ts
  file_src_modules_report_markdown_report_service_ts --> file_src_modules_report_report_types_ts
  file_src_modules_report_markdown_report_service_ts --> file_src_modules_report_workspace_report_service_ts
  file_src_modules_report_markdown_report_service_unit_test_ts --> file_src_modules_report_markdown_report_service_ts
  file_src_modules_report_markdown_report_service_unit_test_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_markdown_report_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_report_markdown_report_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_report_mermaid_report_service_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_mermaid_report_service_ts --> file_src_modules_report_report_types_ts
  file_src_modules_report_mermaid_report_service_unit_test_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_report_mermaid_report_service_unit_test_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_mermaid_report_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_report_mermaid_report_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_report_report_module_ts --> file_src_modules_report_markdown_report_service_ts
  file_src_modules_report_report_module_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_report_report_module_ts --> file_src_modules_report_report_service_ts
  file_src_modules_report_report_module_ts --> file_src_modules_report_workspace_report_service_ts
  file_src_modules_report_report_service_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_report_service_unit_test_ts --> file_src_modules_report_report_service_ts
  file_src_modules_report_report_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_report_report_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_report_report_types_ts --> file_src_modules_project_reports_project_reports_types_ts
  file_src_modules_report_workspace_report_service_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_workspace_report_service_ts --> file_src_modules_report_report_types_ts
  file_src_modules_report_workspace_report_service_unit_test_ts --> file_src_modules_report_report_constants_ts
  file_src_modules_report_workspace_report_service_unit_test_ts --> file_src_modules_report_workspace_report_service_ts
  file_src_modules_report_workspace_report_service_unit_test_ts --> file_testing_mocks_ts
  file_src_modules_report_workspace_report_service_unit_test_ts --> file_testing_modules_ts
  file_src_modules_write_destinations_write_destinations_module_ts --> file_src_modules_output_json_output_json_module_ts
  file_src_modules_write_destinations_write_destinations_module_ts --> file_src_modules_output_markdown_output_markdown_module_ts
  file_src_modules_write_destinations_write_destinations_module_ts --> file_src_modules_report_report_module_ts
  file_src_modules_write_destinations_write_destinations_module_ts --> file_src_modules_write_destinations_write_destinations_service_ts
  file_src_modules_write_destinations_write_destinations_service_ts --> file_src_modules_output_json_output_json_service_ts
  file_src_modules_write_destinations_write_destinations_service_ts --> file_src_modules_output_markdown_output_markdown_service_ts
  file_src_modules_write_destinations_write_destinations_service_ts --> file_src_modules_report_markdown_report_service_ts
  file_src_modules_write_destinations_write_destinations_service_ts --> file_src_modules_write_destinations_write_destinations_constants_ts
  file_src_modules_write_destinations_write_destinations_service_ts --> file_src_modules_write_destinations_write_destinations_types_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_output_json_output_json_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_output_markdown_output_markdown_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_report_markdown_report_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_report_mermaid_report_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_report_report_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_report_workspace_report_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_write_destinations_write_destinations_service_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_src_modules_write_destinations_write_destinations_types_ts
  file_src_modules_write_destinations_write_destinations_service_unit_test_ts --> file_testing_mocks_ts
  file_testing_modules_ts --> file_src_modules_output_json_output_json_module_ts
  file_testing_modules_ts --> file_src_modules_output_markdown_output_markdown_module_ts
  file_testing_modules_ts --> file_src_modules_project_reports_project_reports_module_ts
  file_testing_modules_ts --> file_src_modules_report_report_module_ts

⏲️ Codometer

Project

Measured Targets

TypeScript

JavaScript

Python

JSON

YAML

TOML

Shell

SQL

HCL

CSS

Conventions

Jupyter

Markdown

🪙 Coinagerie

The words this project uses that the root glossary does not define, regenerated with nx run callidescope-output:coinagerie-check:write.

• anchor: Start or end marker that delimits a generated block inside a markdown file, so a splice can replace it.
• breadth: Width of a call graph as reported in the breadth section, measured against maximumBreadth.
• callable: Function, method, or constructor declaration that a report lists by display name, id, and stacks.
• headroom: Measure of how far a stack or callable sits below its limit, bucketed into labeled ranges for the report.
• splice: Replace the anchored region of a markdown file with freshly generated text, keeping everything outside it.
• staleness: Verdict that extracted anchored content has drifted from a fresh render, decided by comparing both blocks.
• trace: Call-stack walk recorded for an address or project, the traced paths the report renders.
• unmeasured: Headroom bucket and reading for a callable with no depth measurement, labeled no stacks in reports.
• unread: Project whose files a run never read, which a report flags rather than counting as clean.