Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: remove the "comments rewriter" (#3368)
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. --- By submitting this pull request, I confirm that my contribution is made under the terms of the [Apache 2.0 license]. [Apache 2.0 license]: https://www.apache.org/licenses/LICENSE-2.0
- Loading branch information
1 parent
4d15b5c
commit 50dd3b0
Showing
12 changed files
with
300 additions
and
753 deletions.
There are no files selected for viewing
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
24 changes: 12 additions & 12 deletions
24
packages/jsii-pacmak/test/generated-code/__snapshots__/target-dotnet.test.ts.snap
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
26 changes: 13 additions & 13 deletions
26
packages/jsii-pacmak/test/generated-code/__snapshots__/target-go.test.ts.snap
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.