Handle aliased symbols in namespaces in api check #1926
Merged
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.
Problem
Sometimes the same symbol name appears under different namespaces.
When this happen API Extractor aliases the type with
_<number>
suffix to de-duplicate it and presents the type as exported with alias.This became visible after #1917 got merged.
For example (see https://github.com/aws-amplify/amplify-backend/blob/main/packages/client-config/API.md).
This has led to the following error:
Changes
This PR adds logic to handle the case where type exported from namespace might be aliased.
Validation
Added content to test project. (so that
npm run test:scripts
covers it).This PRs checks.
Checklist
run-e2e
label set.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.