feat(compiler): extract directive docs info #51697
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jelbourn
added
area: compiler
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 8, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 8, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
atscott
approved these changes
Sep 8, 2023
| /** Extractor to pull info for API reference documentation for a TypeScript class. */ | ||
| class ClassExtractor { | ||
| constructor( | ||
| protected declaration: ClassDeclaration, |
There was a problem hiding this comment.
It's somewhat unclear to me what things actually need to be protected here. It seems like just the extract and extractClassProperty methods. reference and checker aren't used at all, at least in this PR.
There was a problem hiding this comment.
My thought process was to make methods that were a "top-level" part of extracting class info protected, but keep things that were more implementation details private. In reality it doesn't really matter, since the class isn't even exported.
checker is used in the next commit to get type info. I think I will need Reference in a future change to get information about which package and/or the symbol comes from, but that is admittedly speculative based on my limited knowledge of the compiler.
jelbourn
force-pushed
the
api-gen-components
branch
from
1fcb335
to
79af85b
Compare
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 8, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
This commit adds a barebones skeleton for extracting information to be used for extracting info that can be used for API reference generation. Subsequent PRs will expand on this with increasingly real extraction. I started with @alxhub's angular#51615 and very slightly polished to get to this minimal commit.
Based on top of angular#51682 This expands on the skeleton previously added to extract docs info for classes, including properties, methods, and method parameters. Type information and Angular-specific info (e.g. inputs) will come in future PRs.
Based on top of angular#51685 This expands on the extraction with information for directives, including inputs and outputs. As part of this change, I've refactored the extraction code related to class and to directives into their own extractor classes to more cleanly separate extraction logic based on type of statement.
jelbourn
force-pushed
the
api-gen-components
branch
from
79af85b
to
676ea32
Compare
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 9, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 15, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 15, 2023
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
|
Changes merged in #51733 |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Based on top of #51685
This expands on the extraction with information for directives, including inputs and outputs. As part of this change, I've refactored the extraction code related to class and to directives into their own extractor classes to more cleanly separate extraction logic based on type of statement.
cc @devversion