Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

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

Closed
JMBeresford opened this issue Feb 10, 2024 · 0 comments · Fixed by #2500
Closed

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

JMBeresford opened this issue Feb 10, 2024 · 0 comments · Fixed by #2500

Comments

@JMBeresford
Copy link
Contributor

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
@JMBeresford JMBeresford added the bug Functionality does not match expectation label Feb 10, 2024
JMBeresford added a commit to JMBeresford/typedoc that referenced this issue Feb 10, 2024
@JMBeresford
Add module readmes to json output
2ada67e 
Resolves TypeStrong#2499
@JMBeresford JMBeresford mentioned this issue Feb 10, 2024
Merged
Gerrit0 pushed a commit that referenced this issue Feb 11, 2024
@JMBeresford
Add module readmes to json output (#2500)
de4d813 
* Add module readmes to json output

Resolves #2499

* deserialize readme unconditionally
@Gerrit0 Gerrit0 removed the bug Functionality does not match expectation label Feb 2, 2025
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add module readmes to json output JMBeresford/typedoc
2 participants
@JMBeresford @Gerrit0