Skip to content
This repository has been archived by the owner on Apr 26, 2023. It is now read-only.

Feature/enhanced type support #4

Closed

Conversation

WHenderson
Copy link
Contributor

  • Replaces visitor pattern / Extends type coverage
  • Better support for complex nested types
  • Attempts reference resolution directly before falling back to source maps
  • Normalize path separators to support cross platform
  • Replace usage of rm with rimraf in package scripts to support windows

Copy link
Owner

@nlepage nlepage left a comment

Choose a reason for hiding this comment

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

Hi @WHenderson
Thanks for your contribution!
I don't have time to perform a full review right now.
I should be able to by the end of next week.

src/index.ts Outdated Show resolved Hide resolved
@nlepage nlepage added the enhancement New feature or request label Mar 26, 2022
WHenderson added 3 commits April 8, 2022 09:21
Replace `rf` with `rimraf`
Not all projects are built before being typedoc-ed. In these situations, source maps are not available
@nlepage nlepage force-pushed the feature/enhanced-type-support branch from 67a8a8d to 0b0b241 Compare April 8, 2022 07:23
WHenderson and others added 4 commits April 8, 2022 09:25
@nlepage nlepage force-pushed the feature/enhanced-type-support branch from 0b0b241 to 0a98d91 Compare April 8, 2022 07:26
@nlepage
Copy link
Owner

nlepage commented Apr 8, 2022

Hi @WHenderson

Sorry for the delay.

I took the initiative of reordering the commits, in order to add the new examples before the visitor's refactoring.
I also added a commit with some tests on the new examples.

Turns out the new examples were already working without the refactoring (except for the Intersection but this was a bug in Typedoc itself, fixed here : TypeStrong/typedoc#1910)

Ideally I'd like to have some examples that highlight the need for the refactoring.
Could you add some, maybe based on failing cases you would have on a project of yourself?

Thanks in advance.

@WHenderson
Copy link
Contributor Author

Hi @WHenderson

Sorry for the delay.

I took the initiative of reordering the commits, in order to add the new examples before the visitor's refactoring. I also added a commit with some tests on the new examples.

Turns out the new examples were already working without the refactoring (except for the Intersection but this was a bug in Typedoc itself, fixed here : TypeStrong/typedoc#1910)

Ideally I'd like to have some examples that highlight the need for the refactoring. Could you add some, maybe based on failing cases you would have on a project of yourself?

Thanks in advance.

A large number of the types weren't correctly linking up in my main mono-repo, so I debugged through the generation steps and came up with this fix. As you can tell from the order of commits, I didn't use TDD and am surprised that all the types correctly linked even without the changes.

If I find some time I'll see if I can create a test case that justifies the fix. Right now I'm just trying to get my repo to the stage I can make it public (sorting documentation and licensing).

Thanks for taking the time though and also for creating this extension in the first place!

@nlepage
Copy link
Owner

nlepage commented Jul 22, 2022

Hi @WHenderson
I published a new release v0.2.0 for typedoc v0.23 compatibility.
This new version doesn't rely on source maps anymore.
I picked up some of your commits on the main branch (windows compatibility, new examples and new tests).
Please let me know if the new version works for you.
Thanks.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants