[api-extractor] Emit /// <reference lib="" /> in rolled up .d.ts #948
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
iclanton
reviewed
Nov 16, 2018
| * | ||
| * /// <reference lib="runtime-library" /> | ||
| */ | ||
| private _dtsLibReferenceDirectives: string[] = []; |
There was a problem hiding this comment.
string [](start = 38, length = 6)
Consider using sets here for better time efficiency.
|
🤗 |
octogonz
pushed a commit
that referenced
this pull request
Nov 21, 2018
octogonz
pushed a commit
that referenced
this pull request
Nov 22, 2018
Delete deadwood files Rename src -> src-old Bringing over files Bring over more files Bring over more files Bring over more files Bring over more files The dtsRollup generator now builds and works correctly Initial skeleton of AstModel concept Initial prototype of mixins approach Fix serialization of AstMemberMixin Add canonical selector and StaticMixin Replace canonical selector with canonical reference, and support member overloading Add ApiInterface and PropertySignature with declaration merging for interfaces Rename "parameters" to "options" to avoid confusion with TypeScript function parameters Implement parameter serialization Deserialization is now working Set up ApiDeclaration base class for tracking signatures Rename StaticMixin.ts -> ApiStaticMixin.ts Add signature ApiParameter is now a proper ApiDeclaration Convert ApiDeclaration to a mixin upgrade tsdoc rush update Bring over AedocDefinitions.ts Doc comments are now parsed and serialized into .api.json ApiParameter returns docs using tryGetBlockByName Upgrade tsdoc rush update Write a header at the top of the .api.json file - Remove debug code - Wire up the .api.json writer feature - Remove the externalJsonFileFolders feature; if someone really needs this, we'll redesign it Remove obsolete code from TypeScriptHelpers.ts Update IndentedWriter to use StringBuilder Add TSDocFlavor field The `@packageDocumentation` comment is now being emitted again in the .d.ts rollups, sharing the same scanner as ModelBuilder Bring over Markup.ts and MarkupElement.ts Add tsdoc dependency for api-documenter Update MarkdownRenderer.ts to build again Expose ModelBuilder as public API Temporary workaround for declarations that get emitted weirdly by the compiler Add custom DocNode subclasses that will eliminate the need for MarkupElement Make ApiModel and ApiPackage easier to traverse Add ApiItem.getHierarchy() Add ApiReleaseTagMixin Add a test that repros the bug where EcmaScript symbols aren't rolled up properly Fix the bug where EcmaScript symbols were not rolled up correctly rush update Add jest as a dependency so we can debug tests MarkdownDocumenter.ts is now more or less working using TSDoc instead of Markup Fix various files to use the updated TSDoc API Add isBaseClassOf() helper for mixins Export ReleaseTag Add ApiMethodSignature and ApiProperty classes Add ApiResultTypeMixin Add ApiPropertyItem Fix ApiProperty.kind Set up new skeleton for MarkdownDocumenter.ts Function parameters and return value are now documented Generalize MarkdownRenderer to support link resolution Implement a basic TSDoc declaration reference resolver Rename MarkdownRenderer.ts -- MarkdownEmitter.ts Move the test files Rename MarkdownRenderer --> MarkdownEmitter Convert MarkdownEmitter into a non-static class, and separate SimpleWriter into its own source file Separate the non-TSDoc handling into a CustomMarkdownEmitter subclass If the link text is omitted, automatically generate it based on the ApiItem name Add ApiDeclarationMixin.getSignatureWithModifiers() YamlDocumenter and OfficeYamlDocumenter finally build again Move documenter classes under "documenters" folder Move documenter classes under "documenters" folder Minor fixes Moving file Updating imports Move the core DtsRollupGenerator analysis down into ExtractorContext Rename ModelBuilder to ApiModelGenerator Rename ModelBuilder to ApiModelGenerator Rename ExtractorContext --> Collector, and DtsEntry --> CollectorEntity Rename ExtractorContext --> Collector, and DtsEntry --> CollectorEntity Separated package state into CollectorPackage, refactored ApiModelGenerator to reuse the analysis from Collector Bring over ReviewFileGenerator.ts Release tag calculation is now centralized in Collector Fix for GitHub issue #936 where doc comments were not being read for variable declarations Fix some miscellaneous issues for YamlDocumenter.ts Complete _writeAedocSynopsis() Fix .d.ts rollup emitting of doc comments for packages and variable declarations The API Review File now sorts nested members and injects _getAedocSynopsis() comments while preserving .d.ts indentation Don't show redundant release tags in the API review file Fix an issue where getSortKeyIgnoringUnderscore() was case-sensitive and Fix an issue where DeclarationMetadata.needsDocumentation was false when the doc comment was completely missing The test *.d.ts files are now built correctly Disabled API Extractor for projects with incompatibilities: "The symbol X was also exported as Y; this is not supported yet" (GitHub #950) "Program Bug: The symbol GulpTask is being imported after it was already registered as non-imported" (GitHub #949) Add `"tsdocFlavor": "AEDoc"` to projects that build with API Extractor Add missing release tags for declarations that are now picked up by AE7 Don't report release tag errors for the default export Fix table of contents generation The MarkdownDocumenter and YamlDocumenter test output is now correct Improve appearance of VariableDeclaration in .api.ts files Delete left over files from src-old/ Add a test illustrating usage of the `@example` tag MarkdownDocumenter now supports the `@example` tag from TSDoc Move IndentedWriter.ts under src/api Bring over IStringBuilder from TSDoc Merge SimpleWriter and IndentedWriter into a single class MarkdownDocumenter now writes `@deprecated` warnings rush update Manually reapply the fix from PR #948 which got lost in the merge Improve how Sort.compareByValue() handles "null" and "undefined", and add a unit test Add test cases that illustrate Enums being handled incorrectly Update .api.ts files Fix the issue where Enums were sorted incorrectly by Span. Add a test case for access modifiers Add AstDeclaration.modifierFlags and trim private members from *.api.ts and *.api.json
javier-garcia-meteologica
pushed a commit
to javier-garcia-meteologica/rushstack
that referenced
this pull request
Jun 26, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #922
@southpolesteve