Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[api-extractor]: support custom access modifiers for API stripping #3558

Open
Hotell opened this issue Jul 28, 2022 · 0 comments
Open

[api-extractor]: support custom access modifiers for API stripping #3558

Hotell opened this issue Jul 28, 2022 · 0 comments

Comments

@Hotell
Copy link

Hotell commented Jul 28, 2022

Summary

API-Documenter already custom tags via TSDoc. We need similar functionality for access modifier annotations to leverage api stripping based on our needs.

Please check following RFC for more details.

In short we would like to leverage additional acces modifiers for API stripping such as:

  • @rc for Release Candidate
  • @unstable to express @alpha/@beta/@rc via one tag which is all we need

To implement this dtsRollup API config will need to be extended to something like following:

{
"dtsRollup": {
    "enabled": true,
    "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
    "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",,
    "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts"
    "customTrimmedFilePaths": {
         // custom annotation key needs to match with custom tsdoc
         "@rc":  "<projectFolder>/dist/rc/index.d.ts"
         "@unstable":  "<projectFolder>/dist/unstable/index.d.ts"
          ...
      }
  }
}

Standard questions

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

Question Answer
@microsoft/api-extractor version? 7.18.1
Operating system? macos 12
API Extractor scenario? reporting (.api.md) / rollups (.d.ts) / docs (.api.json)
Would you consider contributing a PR? Maybe
TypeScript compiler version? 4.3.5
Node.js version (node -v)? 16

Related issues

@Hotell Hotell changed the title [api-extractor]: support custom access modifiers with API stripping [api-extractor]: support custom access modifiers for API stripping Jul 28, 2022
@github-project-automation github-project-automation bot moved this to Needs triage in Bug Triage Feb 26, 2024
@iclanton iclanton moved this from Needs triage to AE/AD in Bug Triage Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: AE/AD
Development

No branches or pull requests

1 participant