Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Add module readmes to json output #2500

Merged
merged 2 commits into from
Feb 11, 2024
Merged

Conversation

JMBeresford
Copy link
Contributor

Resolves #2499

--

This change attempts to fix the above by mimicking the behavior of the ProjectReflection json serialization, which properly outputs the json readme property.

I skimmed through the test suites, but could not find a good place to integrate a test for this at a glance. Let me know which existing tests should be updated (if needed) and where new test logic should be implemented and I'll dig into it, assuming this change in behavior is acceptable.

Copy link
Collaborator

@Gerrit0 Gerrit0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine merging this without a test update -- I don't have a good way to test packages mode as thoroughly as I'd like yet.

src/lib/models/reflections/declaration.ts Show resolved Hide resolved
Copy link
Collaborator

@Gerrit0 Gerrit0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Module DeclarationReflections are missing readme property in --json output with --entryPointStrategy=packages
2 participants