Skip to content

[api-extractor] Canonical names are getting suffixed with _2 unnecessarily. #3581

Description

@TheDrone7

Summary

When running the API extractor, my interface StorageManager and interface ImageData get suffixed with a _2 in their canonical names, however, their references remain the right name.

The source code is available at https://github.com/TheDrone7/shieldbow

The source code where I am getting the issue is available in the weird-docs branch - https://github.com/TheDrone7/shieldbow/tree/weird-docs

Even after bumping to the new version, it worked right a few times but suddenly started happening a couple of hours before this issue was created.

Repro steps

Fork the repo linked above.

Simply just run the API extractor and when I went to check the extracted json file, it had _2, can be confirmed by running the npm docs:gen script and then seeing the generated docs by running docs:dev.

Standard questions

Please answer these questions to help us investigate your issue more quickly:

Question Answer
@microsoft/api-extractor version? 7.29.0
Operating system? Arch Linux (Kernel 5.18.16)
API Extractor scenario? docs (.api.json)
Would you consider contributing a PR? Yes
TypeScript compiler version? 4.7.4
Node.js version (node -v)? 16.16.0

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions