Improve support for --entryPointStrategy Packages

[akphi]

This PR provides some improvements for users of --entryPointStrategy Packages. These includes:

• Improved support for --entryPointStrategy Packages. TypeDoc will now load package-specific configurations from package.json typedoc field. This configuration allows configuring a custom display name (typedoc.displayName) field, entry point (typedoc.entryPoint - this is equivalent and will override typedocMain), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile), fixes Show README of packages in monorepo #1658
• The --includeVersion option will now be respected by --entryPointStrategy Packages. Also, for this combination, missing version field in the root package.json will not issue a warning - this fix would be useful for folks who want to turn on --includeVersion and yet don't really want to put a version in the main package.json because it's not always meaningful to do so in a monorepo

This is the shape of the typedoc config (in the child-packages' package.json):

export interface TypedocPackageManifestConfig {
    entryPoint?: string | undefined;
    displayName?: string | undefined;
    readmeFile?: string | undefined;
}

I feel that having per-package config allows more flexibility.

This is a screenshot of my change (the README per module and the version per child package)

Screen.Recording.2022-07-02.at.2.51.40.PM.mov

Let me know what you think about these features!

---

UPDATED

I notice that when I develop locally, converter tests will likely fail due to the hardcoded url in the specs.json file. I suppose you don't mind since you run locally and push directly to the repo, for us who work on the fork, these tests will likely fail.

^ Thanks @Gerrit0 ! Works like charms now 🙏

[Gerrit0]

due to the hardcoded url in the specs.json

Shoot, didn't think about that when adding url to the serialized JSON... that's something I should fix.

Edit: Fixed! If you update your fork, shouldn't have that issue anymore.

[akphi]

Also, I'm not so sure, if this is accepted, what's the best way to document this on the website. Is it gonne be through https://typedoc.org/guides/options/#entrypointstrategy ?

[akphi]

@Gerrit0 Do you have any comments on the approach I took for this PR?

[Gerrit0]

This is big enough I need to wait until I'm on a computer to really take a look at it. I'm not entirely sure I like adding another property to declaration reflections, but it might be a good temporary workaround until 0.24 when adding support for arbitrary markdown documents.... should be able to look at it Wednesday at the latest

[akphi]

This is big enough I need to wait until I'm on a computer to really take a look at it. I'm not entirely sure I like adding another property to declaration reflections, but it might be a good temporary workaround until 0.24 when adding support for arbitrary markdown documents.... should be able to look at it Wednesday at the latest

Yep, that was my worry as well, since I copied it from ProjectReflection, but I don't think we have a separate thing like PackageReflection yet. Anyway, glad I'm not totally off 😄

[Dayday10]

I need to know more about this ?

[Dayday10]

Has this been resolved yet? Shannon Day

…

On Mon, Jul 4, 2022, 10:56 AM Gerrit Birkeland ***@***.***> wrote: This is big enough I need to wait until I'm on a computer to really take a look at it. I'm not entirely sure I like adding another property to declaration reflections, but it might be a good temporary workaround until 0.24 when adding support for arbitrary markdown documents.... should be able to look at it Wednesday at the latest — Reply to this email directly, view it on GitHub <#1977 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AWMIKFORQVVBPTSICOE3CDLVSMCUVANCNFSM52OWT6HA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[akphi]

@Gerrit0 I have addressed most of the PR comments, except for the ones related to displayName and version in entry-point.ts file, I want to hear your opinion about that approach so I could move forward.

[akphi]

To clear out the reviews comment while I work on them, I have taken the liberty to resolve some of them, I hope you're okay with this. I will unresolve them once I finish fixing the code 🙏

[Gerrit0]

I have taken the liberty to resolve some of them

Go right ahead :) I always do a full pass before approving anyways, so this won't result in missing anything.

[akphi]

Addressed most comments except for the one about readmeFile.

You can see in the following screenshot, version will now be picked up and will show in the HTML, but not affect the output reflection name (hence the URL does not contain version)

[akphi]

I believe we have resolved all the review comments. Thank you so much for your help and patience @Gerrit0 🙏 !

[Gerrit0]

Thank you! Almost all of the monorepo support in TypeDoc has come from someone who uses them adding support, so it's great to get PRs from people that use them