Skip to content

Module DeclarationReflections are missing readme property in --json output with --entryPointStrategy=packages #2499

Closed
@JMBeresford

Description

@JMBeresford

Search terms

readme, json, --json, packages, monorepo, readme.md

Expected Behavior

When using entryPointStrategy=packages, I would expect the --json output to include readme properties for the modules that have README.md files present.

Actual Behavior

These readmes are present in the rendered HTML for the modules, but omitted from the json output.

Steps to reproduce the bug

Repro: TypeStrong/typedoc-repros#38

Manually:

  1. Setup a project that uses entryPointStrategy=packages
    1a. For example, with entryPoints=['packages/*']
  2. Ensure packages/a/README.md and packages/b/README.md exist, following this example
  3. Verify the readme's are rendered in the HTML output, but not the --json output

Environment

  • Typedoc version: 0.25.2
  • TypeScript version: 5.2.2
  • Node.js version: 19.9.0
  • OS: MacOS

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions