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

fix: remove the "comments rewriter" #3368

Merged
merged 3 commits into from Feb 7, 2022
Merged

fix: remove the "comments rewriter" #3368

merged 3 commits into from Feb 7, 2022

Commits on Feb 7, 2022

  1. fix: remove the "comments rewriter"

    The comments rewriter was used to prefix documentation comments with the
    stability level of the associated API (e.g: `(experimental)` or
    `(deprecated)`). This was introduced to palliate insufficient IDE
    support for `@deprecated` and the mixing of `@stable` and
    `@experimental` APIs in CDK v1.
    
    Since then, the TypeScript language server has added support for
    `@deprecated` IDE features, and CDK v2 moved all `@experimental` APIs to
    separate packages, removing the risk for people to inadvertently take
    experimental dependencies.
    
    In profiling, this feature alone was attributed between 50% and 60% of
    the total time spent compiling `aws-cdk-lib`. The impact is likely
    comparable on other large construct libraries.
    
    The benefits from this feature are not sufficient to justify the cost to
    make it happen. Instead of trying to optimize it (which could prove
    impossible), decision was made to simply drop it.
    RomainMuller committed Feb 7, 2022
    Configuration menu
    Copy the full SHA
    e7ff16a View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    2f01a24 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    7c6cebf View commit details
    Browse the repository at this point in the history